Skip to content

Commit feb008e

Browse files
committed
docs(readme): add usage of commitizen
1 parent 7e436b4 commit feb008e

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,32 @@ Checkout the project and run `make install`, the following output below indicate
1515
Git SubCommand installed successfully, run with "git cz".
1616
```
1717

18-
# Usage
19-
```git cz```
18+
## Commit with commitizen
19+
```shell
20+
git cz
21+
```
22+
2023
![git-cz](docs/images/git-cz.png)
2124

25+
# Usage
26+
```shell
27+
Usage:
28+
commitizen [flags]
29+
commitizen [command]
30+
31+
Available Commands:
32+
completion Generate the autocompletion script for the specified shell
33+
help Help about any command
34+
install install git-cz command
35+
version print tool version
36+
37+
Flags:
38+
--dry-run preview result
39+
-h, --help help for commitizen
40+
41+
Use "commitizen [command] --help" for more information about a command.```
42+
43+
2244
# Configuration
2345
You can customize your commit configuration to project root path or user home directory with json file .git-czrc which format like below:
2446
```json

0 commit comments

Comments
 (0)