mirror of
https://github.com/rzmk/commit-helper.git
synced 2025-12-19 05:29:24 +00:00
docs: include --debug info and rename headers
This commit is contained in:
parent
e7d3ea7d59
commit
8780968e36
1 changed files with 14 additions and 0 deletions
14
README.md
14
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/)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue