# conventional-commits-changelog-generator

[![Maintenance](https://img.shields.io/badge/maintenance-actively%20maintained-brightgreen.svg)](https://github.com/conventional-commits-rs/conventional-commits-changelog-generator)
[![crates.io](https://img.shields.io/crates/v/conventional-commits-changelog-generator.svg)](https://crates.io/crates/conventional-commits-changelog-generator)
[![crates.io](https://img.shields.io/crates/d/conventional-commits-changelog-generator)](https://crates.io/crates/conventional-commits-changelog-generator)
[![Documentation](https://docs.rs/conventional-commits-changelog-generator/badge.svg)](https://docs.rs/conventional-commits-changelog-generator)

> A CLI and library for generating the changelog based on conventional commits.

## Installation

The library can be added to your project as usual. If you want to install the binary, then please run this command:

```text
cargo install conventional-commits-changelog-generator --locked --features cli
```

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
  https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.