Skip to content

Commit 67f8b5d

Browse files
committed
docs: list format
1 parent 83914a4 commit 67f8b5d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

readme.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ To see an example of this in action, you can check the actions file for this rep
1414

1515
The usage is pretty simple, this cli tool assumes that you use [commitlint standards](https://github.com/conventional-changelog/commitlint#what-is-commitlint) while writing your commits, if not it's okay everything will be classified under `Other Changes` instead of being grouped according to type of commit.
1616

17-
**Simple Overview**
18-
`ci: <message>` - for ci/cd changes
19-
`feat|feature: <message>` - for feature changes
20-
`docs: <message>` - for documents or comment updations in code
21-
`refactor: <message>` - performance / code clean up changes or total BLOC changes
22-
`fix: <message>` - for fixes (self-explanatory)
23-
17+
**Simple Overview**
18+
`ci: <message>` - for ci/cd changes
19+
`feat|feature: <message>` - for feature changes
20+
`docs: <message>` - for documents or comment updations in code
21+
`refactor: <message>` - performance / code clean up changes or total BLOC changes
22+
`fix: <message>` - for fixes (self-explanatory)
23+
24+
25+
### Example Output (from this exact repository)
2426

2527
```sh
26-
commitlog path/to/repository
28+
> commitlog path/to/repository
2729
```
2830

29-
### Example Output (from this exact repository)
30-
3131
```markdown
3232
# Changelog
3333

0 commit comments

Comments
 (0)