Skip to content

Commit 1e74d28

Browse files
committed
docs(index): add version command
1 parent 80d47d5 commit 1e74d28

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[![Github Actions](https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg?style=flat-square)](https://github.com/Woile/commitizen/actions)
32
[![Conventional
43
Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
@@ -8,7 +7,6 @@ release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https:
87
versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/)
98
[![Codecov](https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square)](https://codecov.io/gh/Woile/commitizen)
109

11-
1210
![Using commitizen cli](images/demo.gif)
1311

1412
## About
@@ -49,6 +47,7 @@ sudo pip3 install -U Commitizen
4947
### Python project
5048

5149
You can add it to your local project using one of these:
50+
5251
```bash
5352
pip install -U commitizen
5453
```
@@ -61,14 +60,17 @@ poetry add commitizen --dev
6160

6261
### Commiting
6362

64-
6563
Run in your terminal
6664

67-
cz commit
65+
```bash
66+
cz commit
67+
```
6868

6969
or the shortcut
7070

71-
cz c
71+
```bash
72+
cz c
73+
```
7274

7375
### Help
7476

@@ -94,7 +96,10 @@ commands:
9496
info show information about the cz
9597
schema show commit schema
9698
bump bump semantic version based on the git log
97-
check validates that a commit message matches the commitizen schema
99+
version get the version of the installed commitizen or the
100+
current project (default: installed commitizen)
101+
check validates that a commit message matches the commitizen
102+
schema
98103
```
99104

100105
## Contributing

0 commit comments

Comments
 (0)