Skip to content

Commit

Permalink
docs: include --debug info and rename headers
Browse files Browse the repository at this point in the history
  • Loading branch information
rzmk committed Nov 29, 2023
1 parent e7d3ea7 commit 8780968
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand Down

0 comments on commit 8780968

Please sign in to comment.