Skip to content

Commit a417c47

Browse files
committed
docs: readme update
1 parent 97c582b commit a417c47

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

readme.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,36 @@
11
# Commitlog
22

3-
Changelog generator using Commit History
3+
Changelog generator using Commit History
44

55
# UNDER DEV
66

7-
it is usable by manualling installing the go package for now and isn't available as a binary right now, still under heavy development
7+
it is usable by manualling installing the go package for now and isn't available as a binary right now, still under heavy development
88

9-
## Current Limitations
10-
- Cannot Specify a commit/tag to consider as the source of log
11-
- No Tests added so is probably unstable right now
9+
```sh
10+
commitlog path/to/repository
11+
```
12+
13+
### Example Output (from this exact repository)
14+
15+
```markdown
16+
# Changelog
17+
18+
## Fixes
19+
20+
97c582b3eb5a6796ef9c250d9653ad90dce63cbe - fix: example fix
21+
22+
## Other Changes
23+
24+
da6d837eb3134f836bfbe401de7882f2e0818ba8 - Create LICENSE
25+
b0f1b1d2bc4265cb72b70b3ae5b60f8e65f47b12 - initial commit
26+
```
27+
28+
## Current Limitations
29+
30+
- Cannot Specify a commit/tag to consider as the source of log
31+
- No Tests added so is probably unstable right now
1232
- Generates a huge markdown output of the whole repository from inception /initial commit
1333

14-
## Contribution
34+
## Contribution
35+
1536
You are free to raise PR's for any kind of improvements and or feature additions, they'll be added to the repository accordingly, you can also fork up your own version

0 commit comments

Comments
 (0)