Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update about-package-readme-files.mdx #1296

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update about-package-readme-files.mdx #1296

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cfcf4c
docs: Update about-package-readme-files.mdx
kenshanta Sep 25, 2024
84fbe58
docs: Update about-package-readme-files.mdx-vol2
kenshanta Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ...nd-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: About package README files
title: About package README.md files
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They do not have to be .md files. The file name can just be README.

The title is probably best to leave as-is.

Prescribing README.md below in the actual copy below is good still though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed for the sake of consistency.
README files - in my limited experience - are always in markdown format just as package is in JSON format i.e package.json

---

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

An npm package README file must be in the root-level directory of the package.
An npm package `README.md` file **must** be in the root-level directory of the package.

## Creating and adding a README.md file to a package
## Creating and adding a `README.md` file to a package

1. In a text editor, in your package root directory, create a file called `README.md`.
2. In the `README.md` file, add useful information about your package.
Expand All @@ -18,9 +18,9 @@ An npm package README file must be in the root-level directory of the package.

</Note>

## Updating an existing package README file
## Updating an existing package `README.md` file

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

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

Expand Down