Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Oct 26, 2016
1 parent b09c7a4 commit d43a70f
Showing 1 changed file with 13 additions and 19 deletions.
32 changes: 13 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -28,27 +32,17 @@ Command arguments:
<data> 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 <path> 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
Expand Down

0 comments on commit d43a70f

Please sign in to comment.