Defkon1 / readme-md-generator

πŸ“„ CLI that generates beautiful README.md files

Home Page:https://www.npmjs.com/package/readme-md-generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to readme-md-generator πŸ‘‹

downloads License: MIT gitmoji-changelog Twitter: FranckAbgrall

CLI that generates beautiful README.md files.
readme-md-generator will suggest you default answers by reading your package.json and git configuration.

✨ Demo

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process:

demo

Generated README.md:

cli output

Example of package.json with good meta data:

// The package.json is not required to run README-MD-GENERATOR
{
  "name": "readme-md-generator",
  "version": "0.1.3",
  "description": "CLI that generates beautiful README.md files.",
  "author": "Franck Abgrall",
  "license": "MIT",
  "homepage": "https://github.com/kefranabg/readme-md-generator#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/kefranabg/readme-md-generator.git"
  },
  "bugs": {
    "url": "https://github.com/kefranabg/readme-md-generator/issues"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

πŸš€ Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Just run the following command at the root of your project and answer questions:

npx readme-md-generator

Or use default values for all questions (-y):

npx readme-md-generator -y

Use your own ejs README template (-p):

npx readme-md-generator -p path/to/my/own/template.md

You can find ejs README template examples here.

🀝 Contributing

Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Check the contributing guide.

Contributors

Franck Abgrall
Franck Abgrall

πŸ’» πŸ“– ⚠️ πŸ’¬ πŸ› 🚧
Yann Bertrand
Yann Bertrand

πŸ’» ⚠️
Nik
Nik

πŸ’» πŸ“– ⚠️
Saffaanh Soobratty
Saffaanh Soobratty

πŸ’»
Samuel Sharpe
Samuel Sharpe

πŸ“–
Alecsandru Patrascu
Alecsandru Patrascu

πŸ’»
Milad Nekofar
Milad Nekofar

πŸ’» ⚠️ πŸ€”
Bao Ho
Bao Ho

πŸ’» ⚠️
Sasha Semanyuk
Sasha Semanyuk

πŸ’»
Antoine Caron
Antoine Caron

πŸ’» ⚠️ πŸ€”
Swapnik Katkoori
Swapnik Katkoori

πŸ’»
Thibaud Courtoison
Thibaud Courtoison

πŸ’»
Brian Douglas
Brian Douglas

πŸ’»
Kushagra
Kushagra

πŸ’»
David Da Silva
David Da Silva

πŸ’»
Thomas Betous
Thomas Betous

πŸ’»
Lucas Henrique Procopio
Lucas Henrique Procopio

πŸ’»
Ankit Tiwari
Ankit Tiwari

πŸ’»
Johan Bonneau
Johan Bonneau

πŸ’»
Hugo Wood
Hugo Wood

πŸ’»

Author

πŸ‘€ Franck Abgrall

Show your support

Please ⭐️ this repository if this project helped you!

πŸ“ License

Copyright Β© 2019 Franck Abgrall.
This project is MIT licensed.


This README was generated with ❀️ by readme-md-generator

About

πŸ“„ CLI that generates beautiful README.md files

https://www.npmjs.com/package/readme-md-generator

License:MIT License


Languages

Language:JavaScript 100.0%