readme-template-generator
v0.9.13
Published
CLI to help create readme file to document your project
Downloads
28
Maintainers
Readme
A readme template generator for your repositories
🔖 Table Of Contents
- 🤔 How To Use
- 🚀 Technologies
- 🌱 Minimal Requirements
- 🎊 Features
- 🎇 Finished
- 💡 How To Contribute
- 🤗 Contributors
- 👤 Author
- 🔏 License
💻 Desktop
If you use Linux, try run commands bellow as sudo
npm i -g readme-template-generator
or
yarn global add readme-template-generator
🌐 Online
npx readme-template-generator
or using yarn v2-beta
yarn dlx readme-template-generator
- Gluegun
- Node
- Typescript
- EJS
- NPM/Yarn LTS
- NodeJs
- [x] Finished template
- [x] Added emoji in questions
- [x] Integration with GitHub
- [x] Inform if need update
- Make a fork of this repository
- Clone to you machine and entry on respective paste
- Create a branch with your resource:
git checkout -b my-feature
- Commit your changes:
git commit -m 'feat: My new feature'
- Push your branch:
git push origin my-feature
- A green button will appear at the beginning of this repository
- Click to open and fill in the pull request information
🤓 Mikael Aquino [email protected]
- Twitter: @mikaelr16
- Github: @Mikael-R
- LinkedIn: @Mikael-R
Copyright © 2020 Mikael Rolim de Aquino [email protected]
This project is licensed by MIT License.
This README was generated with 💟 by readme-template-generator