Skip to content

Commit b348d77

Browse files
committed
docs: fix readme to adjust to change requests
1 parent a446638 commit b348d77

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,14 @@ jobs:
8686
8787
## CLI (Command Line Interface)
8888
89-
### Help Example
89+
### Installation
90+
9091
```shell
92+
pip install commitlint
93+
```
94+
95+
### Usage
96+
```
9197
$ commitlint --help
9298
usage: commitlint [-h] [-V] [--file FILE] [--hash HASH] [--from-hash FROM_HASH] [--to-hash TO_HASH] [--skip-detail] [commit_message]
9399
@@ -107,7 +113,7 @@ optional arguments:
107113
--skip-detail Skip the detailed error message check
108114
```
109115

110-
### Usage Examples
116+
### Examples
111117
Check commit message directly:
112118

113119
```shell

0 commit comments

Comments
 (0)