dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0
@reggi/path-to-regexp
dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
dependabot/npm_and_yarn/main/eslint-10.4.0
dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0
dependabot/npm_and_yarn/main/proc-log-7.0.0
dependabot/npm_and_yarn/npm_and_yarn-826852524d
dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2
deprecate-totp-2fa
dhei/classic-tokens
gat-bypass-2fa-docs
jpg619/fix-accessibility-content-flow
jpg619/version-bump-tar-2
kartykp/gat-bypass-2fa-docs
kartykp/upgrade-path-to-regex
main
maitxn/version-bump-tar
patch-1
reggi/cache-based-on-version
reggi/dev-engines
reggi/fix-transform-prettier
reggi/overrides
update-search-sensitivity
| 1 | --- |
| 2 | title: About package README files |
| 3 | --- |
| 4 | |
| 5 | We highly recommend including a `README.md` file in your package directory as it helps developers find your package on npm and have a good experience using your code in their projects. In most cases `README.md` files include directions for _installing_, _configuring_, and _using_ the code in your package; as well as any other information a user may find helpful. Just like in any GitHub repository, the `README.md` file will be rendered on the package's page. On [npmjs.com](https://www.npmjs.com/), the `README.md` is rendered as [GitHub Flavored Markdown](https://github.github.com/gfm/) via [GitHub's API](https://docs.github.com/en/rest/markdown/markdown). |
| 6 | |
| 7 | An npm package `README.md` file **must** be in the root-level directory of the package. |
| 8 | |
| 9 | ## Creating and adding a `README.md` file to a package |
| 10 | |
| 11 | 1. In a text editor, in your package root directory, create a file called `README.md`. |
| 12 | 2. In the `README.md` file, add useful information about your package. |
| 13 | 3. Save the `README.md` file. |
| 14 | |
| 15 | <Note> |
| 16 | |
| 17 | **Note:** The file extension `.md` indicates a Markdown file. For more information about Markdown, see the GitHub Guide "[Mastering Markdown](https://guides.github.com/features/mastering-markdown/#what)". |
| 18 | |
| 19 | </Note> |
| 20 | |
| 21 | ## Updating an existing package `README.md` file |
| 22 | |
| 23 | The `README.md` file will only be updated on the package page when you publish a new version of your package. To update your `README.md` file: |
| 24 | |
| 25 | 1. In a text editor, update the contents of the `README.md` file. |
| 26 | |
| 27 | 2. Save the `README.md` file. |
| 28 | |
| 29 | 3. On the command line, in the package root directory, run the following commands: |
| 30 | |
| 31 | ``` |
| 32 | npm version patch |
| 33 | npm publish |
| 34 | ``` |
| 35 | |
| 36 | [markdown-link]: https://guides.github.com/features/mastering-markdown/#what |