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
- Fast.
- Lightweight.
- Quickly generate your README file.
- Good for all kind of projects.
Note - If you had
[email protected]
or more you can skip this section.
You can install get-good-readme by entering this command
npm install -g get-good-readme
- Create a new folder.
- Open your terminal and go inside the new folder.
- If you had npx:
- if you had npx run
npx get-good-readme
and follow the instructions.
- if you had npx run
- 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.
npx get-good-readme -p=project-name -g=github-user -d="describe why you're creating this project."
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!
List of maintainers, replace all href
, src
attributes by your maintainers datas.
Tostee Lucas π» |
MIT