帮助别人在npm上找到你的包并且在他们项目中应用你的代码有很好的体验,我们建议在你的包的文件夹中包含一个README文件。你的README文件可能包含安装、配置和在你的包中使用他们代码的说明,以及用户可能认为有用的任何其他信息。README文件将会在包的页面上展示。
npm包的README文件必须在包的根级别目录中。
创建README.md文件并将其添加到包中
- 在文本编辑器中,在你的包的根目录中,创建一个名为README.md的文件。
- 在README.md文件中,添加关于包的有用信息。
- 保存README.md文件。
注意:文件扩展名.md表示Markdown文件,更多关于Markdown的信息请见Github指南"Mastering Markdown"
更新已存在包的README文件
只有在发布包的新版本时,才会在包页上更新README文件。更新你的README文件:
- 在文本编辑器中,更新README文件的内容。
- 保存README文件。
- 在命令行,在包的根目录,运行以下命令:
npm version patch
npm publish