Skip to content

Commit 4c2219f

Browse files
committed
Updated docs
1 parent 1056da7 commit 4c2219f

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,33 +45,35 @@ Then, run `git-stats --help` and see what the CLI tool can do.
4545
$ git-stats --help
4646
Usage: git-stats [options]
4747
48+
Local git statistics including GitHub-like contributions calendars.
49+
4850
Options:
51+
-r, --raw Outputs a dump of the raw JSON data.
52+
--record <data> Records a new commit. Don't use this unless you are
53+
a mad scientist. If you are a developer just use
54+
this option as part of the module.
4955
-s, --since <date> Optional start date.
5056
-u, --until <date> Optional end date.
57+
-g, --global-activity Shows global activity calendar in the current
58+
repository.
5159
-n, --no-ansi Forces the tool not to use ANSI styles.
5260
-l, --light Enables the light theme.
61+
-d, --data <path> Sets a custom data store file.
5362
-a, --authors Shows a pie chart with the author related
5463
contributions in the current repository.
55-
-g, --global-activity Shows global activity calendar in the current
56-
repository.
57-
-d, --data <path> Sets a custom data store file.
58-
-f, --first-day <day> Sets the first day of the week.
59-
--record <data> Records a new commit. Don't use this unless you
60-
are a mad scientist. If you are a developer, just
61-
use this option as part of the module.
62-
-r, --raw Outputs a dump of the raw JSON data.
6364
-h, --help Displays this help.
6465
-v, --version Displays version information.
6566
6667
Examples:
67-
git-stats # Default behavior (stats in the last year)
68-
git-stats -l # Light mode
69-
git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now
70-
git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012
68+
$ git-stats # Default behavior (stats in the last year)
69+
$ git-stats -l # Light mode
70+
$ git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now
71+
$ git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012
7172
72-
Your commit history is kept in ~/.git-stats by default. You can create ~/.git-stats-config.json to specify different defaults.
73+
Your commit history is kept in ~/.git-stats by default. You can create
74+
~/.git-stats-config.json to specify different defaults.
7375
74-
Documentation can be found at https://github.com/IonicaBizau/git-stats
76+
Documentation can be found at https://github.com/IonicaBizau/git-stats.
7577
```
7678

7779
## Usage

0 commit comments

Comments
 (0)