Readme-md-generator 能够读取您的环境（package.json，git config ...）以在README.md 创建过程中建议您的默认答案：

生成 read me：

package.json具有良好元数据的示例：

// The package.json is not required to run README-MD-GENERATOR
{
 "name": "readme-md-generator",
 "version": "0.1.3",
 "description": "CLI that generates beautiful README.md files.",
 "author": "Franck Abgrall",
 "license": "MIT",
 "homepage": "https://github.com/kefranabg/readme-md-generator#readme",
 "repository": {
 "type": "git",
 "url": "git+https://github.com/kefranabg/readme-md-generator.git"
 },
 "bugs": {
 "url": "https://github.com/kefranabg/readme-md-generator/issues"
 },
 "engines": {
 "npm": ">=5.5.0",
 "node": ">=9.3.0"
 }
}

安装：

With npm:

npm i -g readme-md-generator

With yarn:

yarn global add readme-md-generator

用法：

只需在项目的根目录运行以下命令并回答问题：

readme

可用选项：

• --version显示readme-md-generator版本号
• -y, --yes 对所有问题使用默认值

GitHub 地址：https://github.com/kefranabg/readme-md-generator

网站崩溃找不到原因？平台搭建无从下手？热门技术不想落伍？想要变强找不到资料？

[IT拯救联盟]，让大牛和同伴拯救你，带你装x带你飞。定期干货分享、大牛专业解答、实用IT工具优选.....

私信小编“联盟”，即可加入我们～