Skip to content

Commit

Permalink
docs(readme): add badges in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shipengqi committed Mar 11, 2024
1 parent f16ba87 commit 82b52be
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# commitizen

[![test](https://github.com/shipengqi/commitizen/actions/workflows/test.yml/badge.svg)](https://github.com/shipengqi/commitizen/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/shipengqi/commitizen/branch/main/graph/badge.svg?token=SMU4SI304O)](https://codecov.io/gh/shipengqi/commitizen)
[![Go Report Card](https://goreportcard.com/badge/github.com/shipengqi/commitizen)](https://goreportcard.com/report/github.com/shipengqi/commitizen)
[![release](https://img.shields.io/github/release/shipengqi/commitizen.svg)](https://github.com/shipengqi/commitizen/releases)
[![license](https://img.shields.io/github/license/shipengqi/commitizen)](https://github.com/shipengqi/commitizen/blob/main/LICENSE)

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.
Expand All @@ -13,8 +19,9 @@ Usage:
commitizen
commitizen [command]
Available Commands:
init Initialize this tool to git-core as git-cz.
Available Commands:
init Install this tool to git-core as git-cz.
version Print the version information.
help Help about any command
Flags:
Expand All @@ -38,7 +45,7 @@ $ git cz

Download the pre-compiled binaries from the [releases page](https://github.com/shipengqi/commitizen/releases) and copy them to the desired location.

Then initialize this tool to git-core as git-cz:
Then install this tool to git-core as git-cz:
```
$ commitizen init
```
Expand Down
7 changes: 4 additions & 3 deletions cmd/cz/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ import (

func NewInitCmd() *cobra.Command {
c := &cobra.Command{
Use: "init",
Short: "Initialize this tool to git-core as git-cz.",
Use: "init",
Aliases: []string{"install"},
Short: "Install this tool to git-core as git-cz.",
RunE: func(_ *cobra.Command, _ []string) error {
src, err := exec.LookPath(os.Args[0])
if err != nil {
Expand All @@ -23,7 +24,7 @@ func NewInitCmd() *cobra.Command {
if err != nil {
return err
}
fmt.Printf("Init commitizen to %s\n", dst)
fmt.Printf("Install commitizen to %s\n", dst)
return nil
},
}
Expand Down

0 comments on commit 82b52be

Please sign in to comment.