README.md

get-readme

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.

---

Content

• Features
• Install
• Usage
• Examples
• Contributing
• Maintainers

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 💻

License ⚖️

MIT

---

File generated with get-good-readme module