目录
关于包的 README 文件
目录
为了帮助其他人在 npm 上找到你的包并在他们的项目中使用你的代码获得良好的体验,我们建议在你的包目录中包含一个 README 文件。你的 README 文件可能包含安装、配置和使用包中代码的说明,以及用户可能认为有帮助的任何其他信息。自述文件将显示在包页面上。
¥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.
npm 包 README 文件必须位于包的根目录中。
¥An npm package README file must be in the root-level directory of the package.