npm 包 embellish-readme 使用教程

在开发一个 npm 包时，写好的代码并不是唯一重要的，一个清晰易懂的 README 文件同样也很重要。而 embellish-readme 这个 npm 包可以帮助我们让 README 文件更加优美。

安装

使用 npm 安装该包：

npm install -g embellish-readme

用法

1. 首先，在你的项目根目录下创建一个 .emreadme 文件夹，并在其中创建一个 template.md 文件。
2. 在 template.md 文件中编写 README 的模板内容。支持 EJS 模板语言，所以你可以使用 EJS 语法来动态生成内容。
3. 运行 emreadme init 命令，该命令将会根据模板文件创建出 README.md 文件，并将其置于你的项目根目录下。

示例

以下是一个示例项目结构：

my-package/
└── .emreadme/
    └── template.md

然后在 .emreadme/template.md 中，我们可以这样定义 README 内容：

# <%= name %>

[![npm version](https://badge.fury.io/js/<%= name %>.svg)](https://www.npmjs.com/package/<%= name %>)

<%= description %>

## Installation

npm install --save <%= name %>

## Usage

```javascript
const <%= camelModuleName %> = require('<%= name %>');

<%= camelModuleName %>();

License

MIT

-- -------------------- ---- -------

----- --------- ----- ------ --------- ---

-- --

-- ---------------- ---------------------------------------- -------

- ----------------------------------------------------------- --------
----------------------------------------------------------------------------------