From 8780968e365bf42e30b27e89a1866c3a8a352904 Mon Sep 17 00:00:00 2001 From: rzmk Date: Wed, 29 Nov 2023 17:21:31 -0500 Subject: [PATCH] docs: include --debug info and rename headers --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 4616f07..655caa5 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,32 @@ To run the tool, simply run `ch` in your terminal. ch ``` +### `-a` + If you want to run `git add -A` before committing, use the `-a` flag ```bash ch -a ``` +### `--dry-run` or `-d` + If you want to do a dry run without actually adding or committing, use the `ch -d` or `ch --dry-run` flag. ```bash ch -d ``` +### `--debug` + +If you want to see the debug output, use the `ch --debug` flag. + +```bash +ch --debug +``` + +Note that the debug output will not be printed if you use the `--dry-run` flag. + ## Tech Stack - [Rust](https://www.rust-lang.org/)