Welcome to readme-md-generator 👋
> 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:
Generated `README.md`:
Example of `package.json` with good meta data:
```json
// 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](https://www.npmjs.com/package/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:
```sh
npx readme-md-generator
```
Or use default values for all questions (`-y`):
```sh
npx readme-md-generator -y
```
Use your own `ejs` README template (`-p`):
```sh
npx readme-md-generator -p path/to/my/own/template.md
```
You can find [ejs README template examples here](https://github.com/kefranabg/readme-md-generator/tree/master/templates).
## Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
## Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/readme-md-generator/contribute)]
### Individuals
### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/readme-md-generator/contribute)]
## 🤝 Contributing
Contributions, issues and feature requests are welcome.
Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues) if you want to contribute.
[Check the contributing guide](./CONTRIBUTING.md).
## Author
👤 **Franck Abgrall**
- Twitter: [@FranckAbgrall](https://twitter.com/FranckAbgrall)
- Github: [@kefranabg](https://github.com/kefranabg)
## Show your support
Please ⭐️ this repository if this project helped you!
## 📝 License
Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).
This project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_