Skip to content

Commit c48139e

Browse files
author
rzmk
committed
docs: modify punctuation and show --dry-run instead of -d
1 parent 2b8d4b1 commit c48139e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,39 +14,39 @@ cargo install --git https://github.com/rzmk/commit-helper
1414

1515
## Usage
1616

17-
To run the tool, simply run `ch` in your terminal.
17+
To run the tool, simply run `ch` in your terminal:
1818

1919
```bash
2020
ch
2121
```
2222

2323
### `-a`
2424

25-
If you want to run `git add -A` before committing, use the `-a` flag
25+
If you want to run `git add -A` before committing, use the `-a` flag:
2626

2727
```bash
2828
ch -a
2929
```
3030

3131
### `-p`
3232

33-
If you want to run `git push` after committing, use the `-p` flag
33+
If you want to run `git push` after committing, use the `-p` flag:
3434

3535
```bash
3636
ch -p
3737
```
3838

3939
### `--dry-run` or `-d`
4040

41-
If you want to do a dry run without actually adding or committing, use the `-d` or `--dry-run` flag.
41+
If you want to do a dry run without actually adding or committing, use the `-d` or `--dry-run` flag:
4242

4343
```bash
44-
ch -d
44+
ch --dry-run
4545
```
4646

4747
### `--debug`
4848

49-
If you want to see the debug output, use the `--debug` flag.
49+
If you want to see the debug output, use the `--debug` flag:
5050

5151
```bash
5252
ch --debug

0 commit comments

Comments
 (0)