2.1.0 • Published 4 years ago
get-good-readme v2.1.0
Content
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 💡
- 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.
Exemples 🖍
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.
License ⚖️
MIT