Skip to content

Commit a5ac9dd

Browse files
committed
misc: update README.md
1 parent 8e892b2 commit a5ac9dd

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,44 +39,71 @@ Download the latest binary from the [releases](https://github.com/radulucut/gitb
3939

4040
```sh
4141
gitbrag ./ --since '2025-01-01' --author 'john@example.com' -O stats.png -B 000 -C fff
42+
```
43+
44+
```sh
4245
gitbrag ./ --since '2025-09-01' --until '2025-10-01' -O stats.png -B fff -C 000 --lang --exclude-files '.*package-lock.json$'
4346
```
4447

4548
#### Filter by date range
4649

4750
```sh
4851
gitbrag ./ --since 2024-01-01
52+
```
53+
54+
```sh
4955
gitbrag ./ --since 2024-01-01 --until 2024-12-31
56+
```
57+
58+
```sh
5059
gitbrag ./ --since 7d
5160
```
5261

5362
#### Filter by author name or email
5463

5564
```sh
5665
gitbrag ./ --author "John Doe"
66+
```
67+
68+
```sh
5769
gitbrag ./ --since 7d --author john@example.com
5870
```
5971

6072
#### Output statistics to PNG file
6173

6274
```sh
6375
gitbrag ./ -O stats.png
76+
```
77+
78+
```sh
6479
gitbrag ./ --output stats.png --background "#282a36"
6580
```
6681

6782
#### Use custom background and foreground colors
6883

6984
```sh
7085
gitbrag ./ -O stats.png -B fff
86+
```
87+
88+
```sh
7189
gitbrag ./ -O stats.png --color "#50fa7b"
90+
```
91+
92+
```sh
7293
gitbrag ./ -O stats.png -B "#282a36" -C "f8f8f2"
94+
```
95+
96+
```sh
7397
gitbrag ./ -O stats.png -B 000 --color fff
7498
```
7599

76100
#### Show language breakdown
77101

78102
```sh
79103
gitbrag ./ -O stats.png --lang
104+
```
105+
106+
```sh
80107
gitbrag ./ -O stats.png --lang -B "#282a36" -C "f8f8f2"
81108
```
82109

@@ -86,6 +113,9 @@ The `--lang` flag adds a visual bar chart showing the percentage breakdown of yo
86113

87114
```sh
88115
gitbrag ./ --exclude-files '.*\.lock$'
116+
```
117+
118+
```sh
89119
gitbrag ./ --exclude-files 'package-lock\.json'
90120
```
91121

@@ -95,6 +125,9 @@ The `--exclude-files` flag accepts a regular expression (https://github.com/goog
95125

96126
```sh
97127
gitbrag ./ --exclude-dirs 'node_modules|vendor'
128+
```
129+
130+
```sh
98131
gitbrag ./ --exclude-dirs '.*test.*'
99132
```
100133

0 commit comments

Comments
 (0)