Skip to content

Commit cb83a54

Browse files
committed
Release v0.1.0
1 parent 1c8b902 commit cb83a54

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,33 @@ history of how it looked like before merging, including the individual commits).
1717
If you are stuck on "traditional" merge mode in your projects, you can still use the tool. It's just that its output will be less
1818
readable because of all the individual commits that are retained + one extra merge commit for every single PR.
1919

20-
## How to run
20+
## Prerequisites
21+
22+
## How to install
2123

2224
```shell
23-
# This downloads the rust toolchain. You can omit this step if you already have a suitable Rust version installed.
24-
curl https://sh.rustup.rs -sSf | sh
25+
$ cargo install changelog-rs
26+
```
2527

28+
You will then have a `changelog-rs` in your path which you can run like this:
29+
30+
```shell
2631
# If you want to generate a changelog entry for a particular version (from-revision and to-revision can be any git ref, i.e. a tag
2732
# or a git commit SHA etc.
28-
cargo run <repo> <from-revision> <to-revision>
33+
$ changelog-rs <repo> <from-revision> <to-revision>
2934

3035
# If you want to generate changelog entries for all versions that are tagged with SemVer compliant tags.
36+
$ changelog-rs <repo>
37+
```
38+
39+
## How to build and run
40+
41+
```shell
42+
# This downloads the rust toolchain. You can omit this step if you already have a suitable Rust version installed.
43+
curl https://sh.rustup.rs -sSf | sh
44+
45+
# Same parameter modes as above can be used.
46+
cargo run <repo> <from-revision> <to-revision>
3147
cargo run <repo>
3248
```
3349

0 commit comments

Comments
 (0)