在前端开发中，我们常常需要编写一些文档来记录项目的功能、使用方法等信息，这些文档通常以 README 文件的形式存在于项目的根目录中。为了方便地生成和更新 README 文件，我们可以使用 npm 包 grunt-readme。
安装
首先，我们需要全局安装 grunt-cli：
--- ------- -- ---------
然后，在项目的根目录下执行以下命令安装 grunt-readme：
--- ------- ------------ ----------
配置
在项目的根目录下创建一个名为 Gruntfile.js 的文件，并在文件中进行如下配置：
-------------- - --------------- -
------------------
------- -
-------- -
--------- - -- ------ ---------
----- --- ---------
------------ -- ----- ----------- -- -- ---------
-------- --------
------- ----- --- -----------------------
-------- -----
-
-
-
---
-----------------------------------
----------------------------- ------------
--在上述配置中，我们定义了一个名为 readme 的任务，该任务的选项中包含 README 文件中需要显示的元数据。在 metadata 对象中，我们可以自定义需要显示的元数据，例如项目名称、版本号、作者等。
使用
在项目的根目录下执行以下命令生成 README 文件：
----- ------
执行该命令后，grunt-readme 会自动根据我们在配置中定义的元数据生成 README 文件，并将其保存到项目的根目录下。
示例
假设我们的项目名称为 example-project，按照上述方式进行配置后，在项目根目录下执行 grunt readme 命令，即可生成以下内容的 README 文件：
- -- ------- - ----- ----------- -- -- ------- -- ------------ -- -------- ------ ---- ----- --- ------- ---------------
Usage
--- -------------- - --------------------------- -- ----- ----- ----- ------------ ----
Credits
TODO: Write credits
License
MIT
-- ------ ---------------------------------------------- -- -- ---- ------------------------------ ------ --------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------