From 4c2219faf31266cb7862386f810363c50aba59bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 23 Oct 2016 12:05:22 +0300 Subject: [PATCH] Updated docs --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d860d58..bb0d555 100644 --- a/README.md +++ b/README.md @@ -45,33 +45,35 @@ Then, run `git-stats --help` and see what the CLI tool can do. $ git-stats --help Usage: git-stats [options] +Local git statistics including GitHub-like contributions calendars. + Options: + -r, --raw Outputs a dump of the raw JSON data. + --record Records a new commit. Don't use this unless you are + a mad scientist. If you are a developer just use + this option as part of the module. -s, --since Optional start date. -u, --until Optional end date. - -n, --no-ansi Forces the tool not to use ANSI styles. - -l, --light Enables the light theme. - -a, --authors Shows a pie chart with the author related - contributions in the current repository. -g, --global-activity Shows global activity calendar in the current repository. + -n, --no-ansi Forces the tool not to use ANSI styles. + -l, --light Enables the light theme. -d, --data Sets a custom data store file. - -f, --first-day Sets the first day of the week. - --record Records a new commit. Don't use this unless you - are a mad scientist. If you are a developer, just - use this option as part of the module. - -r, --raw Outputs a dump of the raw JSON data. + -a, --authors Shows a pie chart with the author related + contributions in the current repository. -h, --help Displays this help. -v, --version Displays version information. Examples: - git-stats # Default behavior (stats in the last year) - git-stats -l # Light mode - git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now - git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012 + $ git-stats # Default behavior (stats in the last year) + $ git-stats -l # Light mode + $ git-stats -s '1 January 2012' # All the commits from 1 January 2012 to now + $ git-stats -s '1 January 2012' -u '31 December 2012' # All the commits from 2012 -Your commit history is kept in ~/.git-stats by default. You can create ~/.git-stats-config.json to specify different defaults. +Your commit history is kept in ~/.git-stats by default. You can create +~/.git-stats-config.json to specify different defaults. -Documentation can be found at https://github.com/IonicaBizau/git-stats +Documentation can be found at https://github.com/IonicaBizau/git-stats. ``` ## Usage