readme-md-generator README

The project's README from github.com/kefranabg/readme-md-generator. As one markdown file: README.md.

Welcome to readme-md-generator 👋

downloads License: MIT gitmoji-changelog Twitter: FranckAbgrall

CLI that generates beautiful README.md files.
readme-md-generator will suggest you default answers by reading your package.json and git configuration.

✨ Demo

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process:

demo

Generated README.md:

cli output

Example of package.json with good meta data:

// 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"
  }
}

🚀 Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Just run the following command at the root of your project and answer questions:

npx readme-md-generator

Or use default values for all questions (-y):

npx readme-md-generator -y

Use your own ejs README template (-p):

npx readme-md-generator -p path/to/my/own/template.md

You can find ejs README template examples here.

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

🤝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.

Author

👤 Franck Abgrall

Show your support

Please ⭐️ this repository if this project helped you!

📝 License

Copyright © 2019 Franck Abgrall.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

readme-md-generator (kefranabg/readme-md-generator)

Searching Database…

这是什么?一个命令行工具,通过问你一系列问题并预填智能默认值,为你的项目生成 README.md 文件。
这是我要导入的库,还是一个独立的命令行工具?它是一个独立的命令行工具,通过 npx 运行,而不是需要导入到代码中的库。
我该如何用它生成 README?在项目根目录运行该命令,然后回答提示的问题;或者使用 -y 参数完全跳过提示,所有问题都使用默认值。
我需要先安装 Node 和 npm 吗?需要。它要求 npm 5.5.0+ 和 node 9.3.0+,因为它是通过 npx 运行的。
建议的默认值有多智能?它会读取你的 package.json 和 git 配置,在生成过程中建议默认答案,因此建议的质量取决于你的 package.json 元数据有多完整。
我可以自定义它生成的 README 模板吗?可以,你可以使用 -p 参数提供自己的 EJS 模板,而不使用内置模板。
它会自动从我的项目中获取哪些信息?它会读取 package.json 中的字段(如 name、description、author)以及你的 git 配置,用来预填仓库名称和作者信息等答案。
Creator
kefranabg
Size
2.6 MB
Stars
11.1K
Age
7y
Commits · 90 Days