关于包的 README 文件

为了帮助其他人在 npm 上找到您的包并在他们的项目中使用您的代码获得良好的体验，我们建议在您的包目录中包含一个 README 文件。您的 README 文件可能包含安装、配置和使用包中代码的说明，以及用户可能认为有帮助的任何其他信息。自述文件将显示在包页面上。

npm 包 README 文件必须位于包的根目录中。

创建 README.md 文件并将其添加到包中

1. 在文本编辑器中，在您的包根目录中，创建一个名为 README.md 的文件。
2. 在 README.md 文件中，添加有关您的包的有用信息。
3. 保存 README.md 文件。

注意：文件扩展名 .md 表示 Markdown 文件。有关 Markdown 的更多信息，请参阅 GitHub 指南 "掌握 Markdown"。

更新现有的包 README 文件

README 文件只会在您发布包的新版本时在包页面上更新。要更新您的 README 文件：

1. 在文本编辑器中，更新 README.md 文件的内容。

2. MiM6RYGYdcZPWnF0ppD3JNsjINe6Us9QiMQPVRW8MJ/JKKDjDwRtDiPtrEzLKjna

3. GXJiLcc4dp/HyAzHXiDVAYLgJfQ2nv56K4oD0dpJuLQEHJk3Zr9UUiEJkiyjirJU6eFE2Iccuh0aAtlJiSW10w==

   npm version patch
   npm publish