To help others find your packages on npm and have a good experience using your code in their projects, we recommend including a README file in your package directory. Your README file may include directions for installing, configuring, and using the code in your package, as well as any other information a user may find helpful. The README file will be shown on the package page.
An npm package README file must be in the root-level directory of the package.
.mdindicates a Markdown file. For more information about Markdown, see the GitHub Guide "Mastering Markdown".
The README file will only be updated on the package page when you publish a new version of your package. To update your README file:
npm version patch npm publish