@usulpro/readme-pro v1.0.0

HOW TO HAVE DIFFERENT README FILES FOR GITHUB AND NPM?

This is NPM version

See also see Github version

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