Updated docs

This commit is contained in:
Ionică Bizău 2018-10-15 15:24:33 -05:00
parent 05fda1bcf6
commit 52d3a08cd9
4 changed files with 122 additions and 123 deletions

View file

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2015-17 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Copyright (c) 2015-18 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View file

@ -76,7 +76,7 @@ Examples:
$ 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.
~/.git-stats-config.js to specify different defaults.
Documentation can be found at https://github.com/IonicaBizau/git-stats.
```
@ -297,7 +297,7 @@ Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
@ -317,7 +317,6 @@ Thanks! :heart:
If you are using this library in one of your projects, add it in this list. :sparkles:
- [`core-server`](https://github.com/SachaSkyhark/Core-Server#readme) (by Vandamme Sacha)—CoreServer
- [`git-stats-fcc-importer`](https://github.com/cmal/git-stats-fcc-importer#readme) (by Yu Zhao)—git-stats importer for FreeCodeCamp users
- [`git-stats-importer`](https://github.com/IonicaBizau/git-stats-importer)—Imports your commits from a repository into git-stats history.

236
package-lock.json generated
View file

@ -1,6 +1,6 @@
{
"name": "git-stats",
"version": "2.10.9",
"version": "2.10.10",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@ -9,7 +9,7 @@
"resolved": "https://registry.npmjs.org/abs/-/abs-1.3.10.tgz",
"integrity": "sha1-napqQ1AQAfN/8VoexIIKRklW/8M=",
"requires": {
"ul": "5.2.13"
"ul": "^5.0.0"
}
},
"add-subtract-date": {
@ -27,7 +27,7 @@
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.0.tgz",
"integrity": "sha512-NnSOmMEYtVR2JVMIGTzynRkkaxtiq1xnFBcdQD/DnNCYPoEPsVJhM98BDyaoNOQIi7p4okdi3E27eN7GQbsUug==",
"requires": {
"color-convert": "1.9.0"
"color-convert": "^1.9.0"
}
},
"ansy": {
@ -35,10 +35,10 @@
"resolved": "https://registry.npmjs.org/ansy/-/ansy-1.0.11.tgz",
"integrity": "sha1-IGb86gqDLaVGEQ2RrZ9Hx+zCcdQ=",
"requires": {
"ansi-styles": "3.2.0",
"custom-return": "1.0.8",
"supports-color": "3.2.3",
"ul": "5.2.13"
"ansi-styles": "^3.0.0",
"custom-return": "^1.0.0",
"supports-color": "^3.1.2",
"ul": "^5.2.1"
}
},
"arrs-to-obj": {
@ -51,8 +51,8 @@
"resolved": "https://registry.npmjs.org/auto-parse/-/auto-parse-1.3.0.tgz",
"integrity": "sha1-w0UMMUeipKlL+h0HARy88NjSIAM=",
"requires": {
"lodash": "4.17.4",
"typpy": "2.3.9"
"lodash": "^4.16.3",
"typpy": "^2.3.6"
}
},
"barbe": {
@ -60,9 +60,9 @@
"resolved": "https://registry.npmjs.org/barbe/-/barbe-3.0.12.tgz",
"integrity": "sha1-2yFa0WdIdt7Cpmxn3BnDM96EATk=",
"requires": {
"iterate-object": "1.3.2",
"regex-escape": "3.4.7",
"typpy": "2.3.9"
"iterate-object": "^1.3.2",
"regex-escape": "^3.0.0",
"typpy": "^2.3.1"
}
},
"bug-killer": {
@ -70,11 +70,11 @@
"resolved": "https://registry.npmjs.org/bug-killer/-/bug-killer-4.4.4.tgz",
"integrity": "sha1-luAyK5Q3orBnLXiqzR7SvvEflFo=",
"requires": {
"ansi-parser": "3.2.8",
"couleurs": "6.0.9",
"daty": "1.1.2",
"deffy": "2.2.2",
"typpy": "2.3.9"
"ansi-parser": "^3.2.5",
"couleurs": "^6.0.6",
"daty": "^1.0.7",
"deffy": "^2.2.2",
"typpy": "^2.3.6"
}
},
"byline": {
@ -87,8 +87,8 @@
"resolved": "https://registry.npmjs.org/camelo/-/camelo-1.1.9.tgz",
"integrity": "sha1-SzwWRClkXgVwvqHpACvhARQ9t7E=",
"requires": {
"regex-escape": "3.4.7",
"uc-first-array": "1.1.7"
"regex-escape": "^3.3.0",
"uc-first-array": "^1.0.0"
}
},
"class-methods": {
@ -96,9 +96,9 @@
"resolved": "https://registry.npmjs.org/class-methods/-/class-methods-1.0.8.tgz",
"integrity": "sha1-86ku5JVfakwrAsUOjEEqLLKlkHs=",
"requires": {
"exclude-arr": "1.0.7",
"static-methods": "1.0.9",
"ul": "5.2.13"
"exclude-arr": "^1.0.0",
"static-methods": "^1.0.0",
"ul": "^5.2.1"
}
},
"cli-box": {
@ -106,11 +106,11 @@
"resolved": "https://registry.npmjs.org/cli-box/-/cli-box-6.0.8.tgz",
"integrity": "sha1-QCGLZbKbsyw434BVrgwDs6kBSe8=",
"requires": {
"ansi-parser": "3.2.8",
"deffy": "2.2.2",
"is-undefined": "1.0.8",
"is-win": "1.0.7",
"ul": "5.2.13"
"ansi-parser": "^3.2.1",
"deffy": "^2.2.1",
"is-undefined": "^1.0.0",
"is-win": "^1.0.0",
"ul": "^5.2.1"
}
},
"cli-circle": {
@ -118,9 +118,9 @@
"resolved": "https://registry.npmjs.org/cli-circle/-/cli-circle-3.2.9.tgz",
"integrity": "sha1-BkEvRpIuZuGJdmnfuEDkzAwcYFg=",
"requires": {
"cli-graph": "3.2.2",
"typpy": "2.3.9",
"ul": "5.2.13"
"cli-graph": "^3.0.0",
"typpy": "^2.3.3",
"ul": "^5.0.0"
}
},
"cli-gh-cal": {
@ -128,17 +128,17 @@
"resolved": "https://registry.npmjs.org/cli-gh-cal/-/cli-gh-cal-1.4.7.tgz",
"integrity": "sha1-MVSA0Fi7BJWaj/wnSRgRsG0rYGw=",
"requires": {
"ansi-parser": "3.2.8",
"bug-killer": "4.4.4",
"cli-box": "6.0.8",
"cli-size": "1.0.7",
"couleurs": "6.0.9",
"deffy": "2.2.2",
"git-stats-colors": "2.3.11",
"moment": "2.19.1",
"tilda": "4.4.11",
"typpy": "2.3.9",
"ul": "5.2.13"
"ansi-parser": "^3.0.0",
"bug-killer": "^4.2.5",
"cli-box": "^6.0.5",
"cli-size": "^1.0.3",
"couleurs": "^6.0.5",
"deffy": "^2.0.0",
"git-stats-colors": "^2.3.8",
"moment": "^2.9.0",
"tilda": "^4.3.3",
"typpy": "^2.0.0",
"ul": "^5.0.0"
}
},
"cli-graph": {
@ -154,7 +154,7 @@
"resolved": "https://registry.npmjs.org/deffy/-/deffy-2.0.0.tgz",
"integrity": "sha1-+C4I7qUYxKCjCx8D7FBNJIryiTI=",
"requires": {
"typpy": "2.0.0"
"typpy": "^2.0.0"
}
},
"typpy": {
@ -178,10 +178,10 @@
"resolved": "https://registry.npmjs.org/cli-pie/-/cli-pie-2.3.3.tgz",
"integrity": "sha1-voZ3W2ypRGNrBf6trEFUzj5Asgg=",
"requires": {
"cli-circle": "3.2.9",
"couleurs": "5.2.1",
"flatcolors": "3.0.0",
"ul": "5.2.13"
"cli-circle": "^3.0.0",
"couleurs": "^5.0.0",
"flatcolors": "^3.0.0",
"ul": "^5.0.0"
},
"dependencies": {
"couleurs": {
@ -211,9 +211,9 @@
"resolved": "https://registry.npmjs.org/clp/-/clp-4.0.8.tgz",
"integrity": "sha1-rCw8oJhpBf5xD+K3WSURolHHaUI=",
"requires": {
"is-number": "2.1.0",
"last-char": "1.3.8",
"match-it": "1.0.7"
"is-number": "^2.1.0",
"last-char": "^1.3.1",
"match-it": "^1.0.0"
}
},
"color-convert": {
@ -221,7 +221,7 @@
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.0.tgz",
"integrity": "sha1-Gsz5fdc5uYO/mU1W/sj5WFNkG3o=",
"requires": {
"color-name": "1.1.3"
"color-name": "^1.1.1"
}
},
"color-name": {
@ -234,10 +234,10 @@
"resolved": "https://registry.npmjs.org/couleurs/-/couleurs-6.0.9.tgz",
"integrity": "sha1-srKj7jfa5Rh1ye/SQ+x+eJSvvJ4=",
"requires": {
"ansy": "1.0.11",
"color-convert": "1.9.0",
"iterate-object": "1.3.2",
"typpy": "2.3.9"
"ansy": "^1.0.0",
"color-convert": "^1.0.0",
"iterate-object": "^1.3.1",
"typpy": "^2.3.1"
}
},
"custom-return": {
@ -245,7 +245,7 @@
"resolved": "https://registry.npmjs.org/custom-return/-/custom-return-1.0.8.tgz",
"integrity": "sha1-6Rzoi0aItls//usf2WE7kjhDe+I=",
"requires": {
"noop6": "1.0.7"
"noop6": "^1.0.0"
}
},
"date-unit-ms": {
@ -258,11 +258,11 @@
"resolved": "https://registry.npmjs.org/daty/-/daty-1.1.2.tgz",
"integrity": "sha1-zTvnp6BhgfXfEFNWlAuUgcYhnGU=",
"requires": {
"add-subtract-date": "1.0.11",
"class-methods": "1.0.8",
"date-unit-ms": "1.1.10",
"diff-dates": "1.0.9",
"formatoid": "1.2.1"
"add-subtract-date": "^1.0.0",
"class-methods": "^1.0.4",
"date-unit-ms": "^1.1.0",
"diff-dates": "^1.0.0",
"formatoid": "^1.0.0"
}
},
"days": {
@ -275,7 +275,7 @@
"resolved": "https://registry.npmjs.org/debug-mode/-/debug-mode-1.0.6.tgz",
"integrity": "sha1-W+5pvIS6LFroG7HWEuFWZtMy3c0=",
"requires": {
"semver": "5.4.1"
"semver": "^5.3.0"
}
},
"deffy": {
@ -283,7 +283,7 @@
"resolved": "https://registry.npmjs.org/deffy/-/deffy-2.2.2.tgz",
"integrity": "sha1-CI9AkTy0cHhlP6b2l8IG4DRx1SM=",
"requires": {
"typpy": "2.3.9"
"typpy": "^2.0.0"
}
},
"diff-dates": {
@ -291,7 +291,7 @@
"resolved": "https://registry.npmjs.org/diff-dates/-/diff-dates-1.0.9.tgz",
"integrity": "sha1-E+zph1iOv8LkhZdTfk5SKOKdc3s=",
"requires": {
"date-unit-ms": "1.1.10"
"date-unit-ms": "^1.1.0"
}
},
"err": {
@ -299,9 +299,9 @@
"resolved": "https://registry.npmjs.org/err/-/err-2.1.8.tgz",
"integrity": "sha1-8Q04ssgTsybp56zRwnsnPqukD4s=",
"requires": {
"barbe": "3.0.12",
"iterate-object": "1.3.2",
"typpy": "2.3.9"
"barbe": "^3.0.4",
"iterate-object": "^1.3.1",
"typpy": "^2.2.0"
}
},
"exclude-arr": {
@ -314,8 +314,8 @@
"resolved": "https://registry.npmjs.org/exec-limiter/-/exec-limiter-3.2.9.tgz",
"integrity": "sha1-3wR2HxH5KfpITVmI+gbsdWYL7Rc=",
"requires": {
"limit-it": "3.2.8",
"typpy": "2.3.9"
"limit-it": "^3.0.0",
"typpy": "^2.1.0"
}
},
"fillo": {
@ -338,10 +338,10 @@
"resolved": "https://registry.npmjs.org/formatoid/-/formatoid-1.2.1.tgz",
"integrity": "sha1-ydUfIOfiX7+ZhH6th9uHnRdPy9o=",
"requires": {
"days": "1.1.1",
"fillo": "1.0.9",
"months": "1.2.0",
"parse-it": "1.0.8"
"days": "^1.0.1",
"fillo": "^1.0.0",
"months": "^1.0.0",
"parse-it": "^1.0.0"
}
},
"function.name": {
@ -349,7 +349,7 @@
"resolved": "https://registry.npmjs.org/function.name/-/function.name-1.0.9.tgz",
"integrity": "sha1-kcRcj5HyACvGgIbGc4crYH3Yc8M=",
"requires": {
"noop6": "1.0.7"
"noop6": "^1.0.1"
}
},
"git-stats-colors": {
@ -357,7 +357,7 @@
"resolved": "https://registry.npmjs.org/git-stats-colors/-/git-stats-colors-2.3.11.tgz",
"integrity": "sha1-sToh59GjccK8en0iYfI+vw31L+0=",
"requires": {
"couleurs": "6.0.9"
"couleurs": "^6.0.5"
}
},
"gitlog-parser": {
@ -365,7 +365,7 @@
"resolved": "https://registry.npmjs.org/gitlog-parser/-/gitlog-parser-0.0.4.tgz",
"integrity": "sha1-YtuYR2UZv637TA05MbG/MB4I8fY=",
"requires": {
"byline": "4.2.2"
"byline": "^4.1.1"
}
},
"gry": {
@ -373,10 +373,10 @@
"resolved": "https://registry.npmjs.org/gry/-/gry-5.0.7.tgz",
"integrity": "sha1-3JjiUO13eOgsSpLCCNc1CzD56c8=",
"requires": {
"abs": "1.3.10",
"exec-limiter": "3.2.9",
"one-by-one": "3.2.6",
"ul": "5.2.13"
"abs": "^1.2.1",
"exec-limiter": "^3.0.0",
"one-by-one": "^3.0.0",
"ul": "^5.0.0"
}
},
"has-flag": {
@ -404,7 +404,7 @@
"resolved": "https://registry.npmjs.org/is-number/-/is-number-2.1.0.tgz",
"integrity": "sha1-Afy7s5NGOlSPL0ZszhbezknbkI8=",
"requires": {
"kind-of": "3.2.2"
"kind-of": "^3.0.2"
}
},
"is-there": {
@ -432,7 +432,7 @@
"resolved": "https://registry.npmjs.org/kind-of/-/kind-of-3.2.2.tgz",
"integrity": "sha1-MeohpzS6ubuw8yRm2JOupR5KPGQ=",
"requires": {
"is-buffer": "1.1.5"
"is-buffer": "^1.1.5"
}
},
"last-char": {
@ -445,10 +445,10 @@
"resolved": "https://registry.npmjs.org/le-table/-/le-table-6.1.7.tgz",
"integrity": "sha1-mvyvT0qNt4fA5m7fRXocxkOeQI4=",
"requires": {
"ansi-parser": "3.2.8",
"cli-box": "6.0.8",
"overlap": "2.2.8",
"ul": "5.2.13"
"ansi-parser": "^3.2.1",
"cli-box": "^6.0.0",
"overlap": "^2.2.1",
"ul": "^5.2.1"
}
},
"limit-it": {
@ -456,7 +456,7 @@
"resolved": "https://registry.npmjs.org/limit-it/-/limit-it-3.2.8.tgz",
"integrity": "sha1-uXsBRhzPVNt3fP3318Dty/sBCUo=",
"requires": {
"typpy": "2.3.9"
"typpy": "^2.0.0"
}
},
"lodash": {
@ -489,7 +489,7 @@
"resolved": "https://registry.npmjs.org/obj-def/-/obj-def-1.0.6.tgz",
"integrity": "sha1-d1ThcohJwvk00f3SvnL+Yn7LWxQ=",
"requires": {
"deffy": "2.2.2"
"deffy": "^2.2.2"
}
},
"one-by-one": {
@ -497,8 +497,8 @@
"resolved": "https://registry.npmjs.org/one-by-one/-/one-by-one-3.2.6.tgz",
"integrity": "sha1-M+Pelthw+alL3LY/ontRcAvhESs=",
"requires": {
"obj-def": "1.0.6",
"sliced": "1.0.1"
"obj-def": "^1.0.0",
"sliced": "^1.0.1"
}
},
"overlap": {
@ -540,7 +540,7 @@
"resolved": "https://registry.npmjs.org/deffy/-/deffy-2.0.0.tgz",
"integrity": "sha1-+C4I7qUYxKCjCx8D7FBNJIryiTI=",
"requires": {
"typpy": "2.0.0"
"typpy": "^2.0.0"
}
},
"typpy": {
@ -564,7 +564,7 @@
"resolved": "https://registry.npmjs.org/parse-it/-/parse-it-1.0.8.tgz",
"integrity": "sha1-6aU73hjIBJ57tBW3PhbTKS346uc=",
"requires": {
"regex-escape": "3.4.7"
"regex-escape": "^3.4.0"
}
},
"prompt-sync": {
@ -577,8 +577,8 @@
"resolved": "https://registry.npmjs.org/promptify/-/promptify-1.0.1.tgz",
"integrity": "sha1-Z8KbwssmG3hOMbclJYxSGUDa3wU=",
"requires": {
"is-win": "1.0.7",
"ul": "5.2.13"
"is-win": "^1.0.4",
"ul": "^5.2.9"
}
},
"r-json": {
@ -616,7 +616,7 @@
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-3.2.3.tgz",
"integrity": "sha1-ZawFBLOVQXHYpklGsq48u4pfVPY=",
"requires": {
"has-flag": "1.0.0"
"has-flag": "^1.0.0"
}
},
"tilda": {
@ -624,26 +624,26 @@
"resolved": "https://registry.npmjs.org/tilda/-/tilda-4.4.11.tgz",
"integrity": "sha1-Fzofl5KJaGduOx/tviy9fdmeJmU=",
"requires": {
"ansi-parser": "3.2.8",
"arrs-to-obj": "1.0.8",
"auto-parse": "1.3.0",
"camelo": "1.1.9",
"clp": "4.0.8",
"debug-mode": "1.0.6",
"deffy": "2.2.2",
"err": "2.1.8",
"indento": "1.1.10",
"is-empty-obj": "1.0.9",
"is-undefined": "1.0.8",
"iterate-object": "1.3.2",
"le-table": "6.1.7",
"prompt-sync": "4.1.5",
"promptify": "1.0.1",
"r-json": "1.2.8",
"remove-blank-lines": "1.0.7",
"typpy": "2.3.9",
"ul": "5.2.13",
"wrap-text": "1.0.7"
"ansi-parser": "^3.2.1",
"arrs-to-obj": "^1.0.0",
"auto-parse": "^1.2.0",
"camelo": "^1.1.2",
"clp": "^4.0.0",
"debug-mode": "^1.0.0",
"deffy": "^2.2.1",
"err": "^2.1.0",
"indento": "^1.1.1",
"is-empty-obj": "^1.0.1",
"is-undefined": "^1.0.0",
"iterate-object": "^1.3.2",
"le-table": "^6.1.0",
"prompt-sync": "^4.1.4",
"promptify": "^1.0.0",
"r-json": "^1.2.1",
"remove-blank-lines": "^1.0.1",
"typpy": "^2.3.1",
"ul": "^5.2.1",
"wrap-text": "^1.0.0"
}
},
"typpy": {
@ -651,7 +651,7 @@
"resolved": "https://registry.npmjs.org/typpy/-/typpy-2.3.9.tgz",
"integrity": "sha1-KGZP2l6nHdcYck+J0ABgrx8Jw44=",
"requires": {
"function.name": "1.0.9"
"function.name": "^1.0.3"
}
},
"uc-first-array": {
@ -659,7 +659,7 @@
"resolved": "https://registry.npmjs.org/uc-first-array/-/uc-first-array-1.1.7.tgz",
"integrity": "sha1-ODfdQnYskk+svSxqt/6wg4VUR8c=",
"requires": {
"ucfirst": "1.0.0"
"ucfirst": "^1.0.0"
}
},
"ucfirst": {
@ -672,8 +672,8 @@
"resolved": "https://registry.npmjs.org/ul/-/ul-5.2.13.tgz",
"integrity": "sha1-n/BQTqNcofdMC/WeZIDe8Am617U=",
"requires": {
"deffy": "2.2.2",
"typpy": "2.3.9"
"deffy": "^2.2.2",
"typpy": "^2.3.4"
}
},
"w-json": {