> Generate changelog for repositories using [gitmoji](https://gitmoji.carloscuesta.me/) commits convention.
## π Usage
Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since npm `5.2.0`)
Run the following command at the root of your project and answer questions. `gitmoji-changelog` uses a [preset system](https://docs.gitmoji-changelog.dev/#/?id=%e2%9a%99%ef%b8%8f-presets) to handle different type of project. The preset used by default is the Node.js one that look for project's information in the `package.json` file.
with npx:
```sh
npx gitmoji-changelog
```
with npm:
```sh
npm install -g gitmoji-changelog
cd my-project
gitmoji-changelog
```
It exists a generic preset that works for every kind of project. It looks for information in a `.gitmoji-changelogrc` file at the root of your project. This file must contain three mandatory properties: `name`, `description` and `version`.
.gitmoji-changelogrc:
```json
{
"project": {
"name": "gitmoji-changelog",
"description": "A changelog generator for gitmoji π",
"version": "2.0.1"
}
}
```
You can change the preset used by `gitmoji-changelog` with the preset option.
```sh
npx gitmoji-changelog --preset generic
```
## π Documentation
:point_right: The full documentation is available [here](https://docs.gitmoji-changelog.dev).
## β Author
π€ **Yvonnick FRIN (https://yvonnickfrin.dev)**
* Twitter: [@YvonnickFrin](https://twitter.com/YvonnickFrin)
* Github: [@frinyvonnick](https://github.com/frinyvonnick)
## π€ Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/frinyvonnick/gitmoji-changelog/issues). You can also take a look at our [contributing guide](CONTRIBUTING.md).
## π Show your support
Give a βοΈ if this project helped you!
You also can add a badge in the README.md of your repository to promote `gitmoji-changelog`. All you need is to copy/past the code below:
```markdown
[](https://github.com/frinyvonnick/gitmoji-changelog)
```
It will add this badge: [](https://github.com/frinyvonnick/gitmoji-changelog)
## β¨ Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## π License
Copyright Β© 2020 [Yvonnick FRIN (https://github.com/frinyvonnick)](https://github.com/frinyvonnick).
This project is [MIT](https://github.com/frinyvonnick/gitmoji-changelog/blob/master/LICENSE) licensed.
***
_This README was generated with β€οΈ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
