@example-org/example-package
This should be scoped package:
Installation
npm install @example-org/example-packageInstallation
Provide code examples and explanations of how to get the project.
API Reference
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Tests
Describe and show how to run the tests with code examples.
Contributors
Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.
License
A short snippet describing the license (MIT, Apache, etc.)