Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.

Welcome to readme-md-generator πŸ‘‹

downloads License: MIT gitmoji-changelog Twitter: FranckAbgrall

CLI that generates beautiful 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 creation process:



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 files.",
  "author": "Franck Abgrall",
  "license": "MIT",
  "homepage": "",
  "repository": {
    "type": "git",
    "url": "git+"
  "bugs": {
    "url": ""
  "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/

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]



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.


πŸ‘€ 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