Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 23167cb

Browse filesBrowse files
authored
docs: Update about-package-readme-files.mdx (#1296)
Use file and code format for README references
1 parent 04c00ee commit 23167cb
Copy full SHA for 23167cb

File tree

1 file changed

+5
-5
lines changed
Filter options

1 file changed

+5
-5
lines changed

‎content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx

Copy file name to clipboardExpand all lines: content/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx
+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: About package README files
33
---
44

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.
66

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.
88

9-
## Creating and adding a README.md file to a package
9+
## Creating and adding a `README.md` file to a package
1010

1111
1. In a text editor, in your package root directory, create a file called `README.md`.
1212
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.
1818

1919
</Note>
2020

21-
## Updating an existing package README file
21+
## Updating an existing package `README.md` file
2222

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:
2424

2525
1. In a text editor, update the contents of the `README.md` file.
2626

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.