diff --git a/content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx b/content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx index c7663c0e203..ccadd3f2f2f 100644 --- a/content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx +++ b/content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx @@ -2,7 +2,7 @@ title: About package README files --- -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. +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). An npm package `README.md` file **must** be in the root-level directory of the package.