https://github.com/usulpro/readme-pro

example of different readme files for Github and NPM
https://github.com/usulpro/readme-pro

documentation github npm readme

Last synced: 16 days ago
JSON representation

example of different readme files for Github and NPM

• Host: GitHub
• URL: https://github.com/usulpro/readme-pro
• Owner: usulpro
• Created: 2021-01-16T16:40:51.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-01-16T17:39:57.000Z (over 5 years ago)
• Last Synced: 2026-02-12T01:40:27.382Z (3 months ago)
• Topics: documentation, github, npm, readme
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@usulpro/readme-pro
• Size: 29.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# HOW TO HAVE DIFFERENT README FILES FOR GITHUB AND NPM?

This is **NPM version**

See also see [Github version](https://github.com/UsulPro/readme-pro)

>If you put your README file in your repository's root, docs, or hidden .github directory, GitHub will recognize and automatically surface your README to repository visitors.

Originally the question was raised on Stackoverflow https://stackoverflow.com/questions/41297117/how-to-specify-different-readme-files-for-github-and-npm

Created with ❤︎ to stackoverflow community by @usulpro [React Theming]