Skip to content

Commit 2980d77

Browse files
authored
docs(usage): update features and help information (#42)
* docs(usage): update help information * docs(usage): update help information * docs(usage): add features in the readme * docs(usage): add more features
1 parent 4239d34 commit 2980d77

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,18 @@
77

88
Command line utility to standardize git commit messages, golang version. Forked from [commitizen-go](https://github.com/lintingzhen/commitizen-go).
99

10-
The [survey](https://github.com/AlecAivazis/survey) project is no longer maintained. Therefore, this project uses [bubbletea](https://github.com/charmbracelet/bubbletea) instead.
10+
Fixes some issues of commitizen-go and supports more new features.
1111

1212
![demo](https://github.com/shipengqi/illustrations/blob/ebe8786a60c6467edb3122723d74d22f639fb216/commitizen/demo.gif?raw=true)
1313

14+
## Features
15+
16+
- Multi-template support
17+
- Dry-run support
18+
- Signed-off support
19+
- Use [bubbletea](https://github.com/charmbracelet/bubbletea) instead of [survey](https://github.com/AlecAivazis/survey) ([survey](https://github.com/AlecAivazis/survey) is no longer maintained).
20+
- Better unit tests.
21+
1422
## Getting Started
1523

1624
```
@@ -20,16 +28,18 @@ Usage:
2028
commitizen
2129
commitizen [command]
2230
23-
Available Commands:
31+
Available Commands:
2432
init Install this tool to git-core as git-cz.
2533
version Print the CLI version information.
2634
help Help about any command
2735
2836
Flags:
29-
-s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message.
30-
-a, --add tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.
31-
--dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it.
32-
-h, --help help for commitizen
37+
-a, --add tell the command to automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.
38+
-s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message.
39+
--dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it.
40+
-t, --template string template name to use when multiple templates exist.
41+
-d, --default use the default template, '--default' has a higher priority than '--template'.
42+
-h, --help help for commitizen
3343
3444
Use "commitizen [command] --help" for more information about a command.
3545
```

0 commit comments

Comments
 (0)