在前端项目开发中，npm 包管理工具是必不可少的工具。对于开发者来说，编写好的 npm 包不仅要代码逻辑优秀，同时还需要详细的文档说明，便于其他开发者使用。但是，编写规范的 README 文档却不是一件容易的事情。幸好，有一个叫做 package-to-readme 的 npm 包可以很方便地将 package.json 中的信息转化为 README.md 文本格式的文件。
package-to-readme 的介绍
package-to-readme 是一个 npm 包，它可以把一个模块的 package.json 中的信息转化为 README.md 格式的文件，包括模块的主要描述、版本号、安装方式、使用方法等等信息。使用这个包，你可以快速得到一份规范的 README.md 文件，方便其他开发者快速上手使用你的模块。
安装和使用 package-to-readme
package-to-readme 只是一个命令行工具，因此它可以通过 npm 安装：
npm install -g package-to-readme
安装完毕以后，可以在自己的项目根目录中使用该工具创建 README.md 文件。
首先，在项目的 package.json 文件中添加必要的描述信息。下面是一个例子：
-- -------------------- ---- -------
-
------- ------------
---------- --------
-------------- --- ------- ------ ---- ---- ------- ---------
------- -----------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
---------- -----
-然后，在命令行中运行：
package-to-readme
这个命令会将 package.json 中的信息转化为 README.md 格式的文件。默认情况下，生成的文件名就是 README.md。
package-to-readme 的参数介绍
package-to-readme 命令支持的参数如下：
--input, -i：指定 package.json 文件的路径，默认值是当前目录下的 package.json 文件。--output, -o：指定生成的 README 文件路径，默认值是当前目录下的 README.md 文件。--template, -t：指定 README 文件生成的模板路径，默认为 package-to-readme 自带的默认模板。
例如，如果要将生成的 README 文件叫做 my-readme.md，可以使用如下命令：
package-to-readme --output my-readme.md
package-to-readme 的扩展
当然，如果你不想使用 package-to-readme 自带的默认模板，你可以自定义 README.md 文件的样式和结构。只需要创建一个模板文件，然后在命令行中指定模板文件的路径即可。模板文件可以使用以下占位符：
{name}：模块的名称，来自于 package.json 文件中的 name 字段。{description}：模块的描述，来自于 package.json 文件中的 description 字段。{version}：模块的版本号，来自于 package.json 文件中的 version 字段。{license}：模块的许可证，来自于 package.json 文件中的 license 字段。{author}：模块的作者，来自于 package.json 文件中的 author 字段。{main}：模块入口文件的路径，来自于 package.json 文件中的 main 字段。
例如，可以编写如下模板文件：
# {name}
{description}
## Installation
```sh
$ npm install {name}Usage
var {name} = require('{name}');Author
{author}
License
{license}
然后，在命令行中运行：
package-to-readme --template my-template.md
-- -------------------- ---- ------- ----------------- --------- ---- -- -- ----------------- -------- --- ----------- --------- --------------------------------------------------- ----------------- ------------ - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------