About package README files

为了帮助其他人在npm上找到您的软件包,并在他们的项目中使用您的代码有丰富的经验,我们建议在您的软件包目录中包含README文件. 您的README文件可能包括安装,配置和使用程序包中的代码的说明,以及用户可能会有所帮助的任何其他信息. 自述文件将显示在软件包页面上.

npm软件包README文件必须位于软件包的根目录下.

Creating and adding a README.md file to a package

  1. 在文本编辑器的程序包根目录中,创建一个名为README.md的文件.
  2. README.md文件中,添加有关程序包的有用信息.
  3. 保存README.md文件.
注意:文件扩展名.md表示Markdown文件. 有关Markdown的更多信息,请参见GitHub Guide" Mastering Markdown ".

Updating an existing package README file

当您发布软件包的新版本时,自述文件将仅在软件包页面上更新. 要更新您的自述文件:

  1. 在文本编辑器中,更新README.md文件的内容.
  2. 保存README.md文件.
  3. 在命令行的程序包根目录中,运行以下命令:
      npm version patch npm publish 

< Creating Node.js modules | Creating and publishing unscoped public packages >

by  ICOPY.SITE