Skip to content


Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time
Logo project


Quickly generate readable and well documented README file. Because documenting is a complicated task get-good-readme is a tiny CLI module which allows you to choose between different README templates for you to keep a coherence between your different projects.

Build Status NPM version Package size Dependencies devDependencies Status code style: prettier Twitter


Features ✨

  • Fast.
  • Lightweight.
  • Quickly generate your README file.
  • Good for all kind of projects.

Install πŸ™

Note - If you had npm@5.2.0 or more you can skip this section.

You can install get-good-readme by entering this command

npm install -g get-good-readme

Usage πŸ’‘

  1. Create a new folder.
  2. Open your terminal and go inside the new folder.
  3. If you had npx:
    • if you had npx run npx get-good-readme and follow the instructions.
  4. If you don't have npx:
    • Check the install section to install the package globally.
    • Then execute the tasks number 1 and 2.
    • Run get-good-readme in your terminal.

Examples πŸ–

npx get-good-readme -p=project-name -g=github-user -d="describe why you're creating this project."

Contributing 🍰

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to this project!

Maintainers πŸ‘·

List of maintainers, replace all href, src attributes by your maintainers datas.

Tostee Lucas
Tostee Lucas


License βš–οΈ