diff --git a/README.md b/README.md index 129ef9c..de4101e 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,18 @@ Command line utility to standardize git commit messages, golang version. Forked from [commitizen-go](https://github.com/lintingzhen/commitizen-go). -The [survey](https://github.com/AlecAivazis/survey) project is no longer maintained. Therefore, this project uses [bubbletea](https://github.com/charmbracelet/bubbletea) instead. +Fixes some issues of commitizen-go and supports more new features. ![demo](https://github.com/shipengqi/illustrations/blob/ebe8786a60c6467edb3122723d74d22f639fb216/commitizen/demo.gif?raw=true) +## Features + +- Multi-template support +- Dry-run support +- Signed-off support +- 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). +- Better unit tests. + ## Getting Started ``` @@ -20,16 +28,18 @@ Usage: commitizen commitizen [command] -Available Commands: +Available Commands: init Install this tool to git-core as git-cz. version Print the CLI version information. help Help about any command Flags: - -s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message. - -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. - --dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it. - -h, --help help for commitizen + -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. + -s, --signoff add a Signed-off-by trailer by the committer at the end of the commit log message. + --dry-run you can use the --dry-run flag to preview the message that would be committed, without really submitting it. + -t, --template string template name to use when multiple templates exist. + -d, --default use the default template, '--default' has a higher priority than '--template'. + -h, --help help for commitizen Use "commitizen [command] --help" for more information about a command. ```