Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

readme-template-generator

Mikael-R82MIT0.9.13

CLI to help create readme file to document your project

generator, cli, readme, readme-template, readme-template-generator

readme

Gitpod

NPM Version NPM Monthly Downloads

License Last Commit Language Most Used Implementations Repository Size

Forks Stars Watches

Author Twitter

Welcome to readme-template-generator 👋

🚧 readme-template-generator in development... 🚧

A readme template generator for your repositories

🔖 Table Of Contents


🤔 How To Use

💻 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

Back To The Top


🚀 Technologies

  • Gluegun
  • Node
  • Typescript
  • EJS

Back To The Top


🌱 Minimal Requirements

  • NPM/Yarn LTS
  • NodeJs

Back To The Top


🎊 Features

🎇 Finished

  • <input checked="" disabled="" type="checkbox"> Finished template
  • <input checked="" disabled="" type="checkbox"> Added emoji in questions
  • <input checked="" disabled="" type="checkbox"> Integration with GitHub
  • <input checked="" disabled="" type="checkbox"> Inform if need update

Back To The Top


💡 How To Contribute

  • 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

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Back To The Top


🤗 Contributors

Back To The Top


👤 Author

🤓 Mikael Aquino mikarg9@gmail.com

Back To The Top


🔏 License

Copyright © 2020 Mikael Rolim de Aquino mikarg9@gmail.com

This project is licensed by MIT License.

Back To The Top


This README was generated with 💟 by readme-template-generator