docs: Update about-package-readme-files.mdx (#1296)
Use file and code format for README references
Sarkis Kovlekjian committed
Oct 9, 2024 at 18:08 UTC
23167cb9fd6221862c1543d5227dedf8e235ba97
1 file changed
+5
-5
content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx
+5
-5
@@ -2,11 +2,11 @@
2
title: About package README files
3
---
4
5
-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.
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.
6
7
-An npm package README file must be in the root-level directory of the package.
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
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.
@@ -18,9 +18,9 @@ An npm package README file must be in the root-level directory of the package.
18
19
</Note>
20
21
-## Updating an existing package README file
21
+## Updating an existing package `README.md` file
22
23
-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:
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