目录
关于包 README 文件
目录
为了帮助其他人找到您在 npm 上的包并在他们的项目中使用您的代码时拥有良好的体验，我们建议在您的包目录中包含一个 README 文件。您的 README 文件可能包括有关安装、配置和使用包中代码的说明，以及用户可能觉得有用的任何其他信息。README 文件将在包页面上显示。
npm 包的 README 文件必须位于包的根目录。
创建并向包中添加 README.md 文件
- 在文本编辑器中，在您的包根目录中，创建一个名为
README.md的文件。 - 在
README.md文件中，添加有关您的包的有用信息。 - 保存
README.md文件。
注意： 文件扩展名 .md 表示 Markdown 文件。有关 Markdown 的更多信息，请参见 GitHub 指南“Markdown 精通”。
更新现有包的 README 文件
只有在您发布包的新版本时，README 文件才会在包页面上更新。要更新您的 README 文件
-
在文本编辑器中，更新
README.md文件的内容。 -
保存
README.md文件。 -
在命令行中，在包根目录中，运行以下命令
npm version patchnpm publish
