rzmk/commit-helper
1
0
Fork 0
mirror of https://github.com/rzmk/commit-helper.git synced 2025-12-19 05:29:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: include --debug info and rename headers

Browse source
This commit is contained in:
rzmk 2023-11-29 17:21:31 -05:00
parent e7d3ea7d59
commit 8780968e36
No known key found for this signature in database
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -18,18 +18,32 @@ To run the tool, simply run `ch` in your terminal.
ch ch
``` ```
### `-a`
If you want to run `git add -A` before committing, use the `-a` flag If you want to run `git add -A` before committing, use the `-a` flag
```bash ```bash
ch -a 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. If you want to do a dry run without actually adding or committing, use the `ch -d` or `ch --dry-run` flag.
```bash ```bash
ch -d 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 ## Tech Stack
- [Rust](https://www.rust-lang.org/) - [Rust](https://www.rust-lang.org/)