diff --git a/README.md b/README.md index 12334c2..8551328 100644 --- a/README.md +++ b/README.md @@ -90,48 +90,41 @@ Otherwise, ensure you have the `clog` binary in the directory which you operatin `clog` works by reading your `git` metadata and specially crafted commit messages and subjects to create a changelog. `clog` has the following options available. ```sh -USAGE: - clog [FLAGS] [OPTIONS] - -FLAGS: - -F, --from-latest-tag use latest tag as start (instead of --from) - -h, --help Prints help information - -M, --major Increment major version by one (Sets minor and patch to 0) - -m, --minor Increment minor version by one (Sets patch to 0) - -p, --patch Increment patch version by one - -V, --version Prints version information - -OPTIONS: - -C, --changelog A previous changelog to prepend new changes to (this is like - using the same file for both --infile and --outfile and - should not be used in conjunction with either) - -c, --config The Clog Configuration TOML file to use (Defaults to - '.clog.toml')** - -T, --format The output format, defaults to markdown - (valid values: markdown, json) - -f, --from e.g. 12a8546 - -g, --git-dir Local .git directory (defaults to current dir + '.git')* - -i, --infile A changelog to append to, but *NOT* write to (Useful in - conjunction with --outfile) - -o, --outfile Where to write the changelog (Defaults to stdout when omitted) - -r, --repository Repository used for generating commit and issue links - (without the .git, e.g. https://github.com/clog-tool/clog-cli) - -l, --link-style