diff --git a/README.md b/README.md index 5e1493f..3062000 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ > Turn git-stats result into HTML output. +Check out [`git-stats`](https://github.com/IonicaBizau/git-stats) for more details about git-stats. + +[![git-stats-html](http://i.imgur.com/hnSUlCx.png)](#) + ## :cloud: Installation You can install the package globally and use it as command line tool: @@ -28,27 +32,17 @@ Command arguments: The input JSON data. Options: - -v, --version Displays version information. - -h, --help Displays this help. - -Documentation can be found at https://github.com/IonicaBizau/git-stats-html#readme. -``` - -## :clipboard: Example - + -o, --output The output file path. Default it will display the + HTML in the stdout. + --big Use this option for bigger than one year calendars. + -v, --version Displays version information. + -h, --help Displays this help. -Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm`: +Examples: + $ git-stats --raw | git-stats-html -o out.html + $ git-stats --since '1 January 2015' --raw | ./bin/git-stats-html -o out.html --big -```sh -$ npm i --save git-stats-html -``` - - - -```js -const gitStatsHtml = require("git-stats-html"); - -console.log(gitStatsHtml()); +Documentation can be found at https://github.com/IonicaBizau/git-stats-html#readme. ``` ## :memo: Documentation