Welcome to readme-md-generator 👋
CLI that generates beautiful README.md files.
readme-md-generatorwill suggest you default answers by reading your
readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the
README.md creation process:
package.json with good meta data:
// The package.json is not required to run README-MD-GENERATOR
Make sure you have npx installed (
npx is shipped by default since npm
Just run the following command at the root of your project and answer questions:
Or use default values for all questions (
npx readme-md-generator -y
Use your own
ejs README template (
npx readme-md-generator -p path/to/my/own/template.md
You can find ejs README template examples here.
This project exists thanks to all the people who contribute. [Contribute].
Become a financial contributor and help us sustain our community. [Contribute]
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
👤 Franck Abgrall
Show your support
Please ⭐️ this repository if this project helped you!
This README was generated with ❤️ by readme-md-generator