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: modify punctuation and show --dry-run instead of -d

Browse source
This commit is contained in:
rzmk 2023-12-01 21:02:26 -05:00
parent 2b8d4b103e
commit c48139ebc6
No known key found for this signature in database
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -14,7 +14,7 @@ cargo install --git https://github.com/rzmk/commit-helper
## Usage ## Usage
To run the tool, simply run `ch` in your terminal. To run the tool, simply run `ch` in your terminal:
```bash ```bash
ch ch
@ -22,7 +22,7 @@ ch
### `-a` ### `-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
@ -30,7 +30,7 @@ ch -a
### `-p` ### `-p`
If you want to run `git push` after committing, use the `-p` flag If you want to run `git push` after committing, use the `-p` flag:
```bash ```bash
ch -p ch -p
@ -38,15 +38,15 @@ ch -p
### `--dry-run` or `-d` ### `--dry-run` or `-d`
If you want to do a dry run without actually adding or committing, use the `-d` or `--dry-run` flag. If you want to do a dry run without actually adding or committing, use the `-d` or `--dry-run` flag:
```bash ```bash
ch -d ch --dry-run
``` ```
### `--debug` ### `--debug`
If you want to see the debug output, use the `--debug` flag. If you want to see the debug output, use the `--debug` flag:
```bash ```bash
ch --debug ch --debug