Updated docs

This commit is contained in:
Ionică Bizău 2017-12-24 22:15:21 +02:00
parent 358ab94023
commit 11c37ae513
3 changed files with 9 additions and 4 deletions

View file

@ -36,6 +36,7 @@ You can install the package globally and use it as command line tool:
```sh
# Install the package globally
npm i -g git-stats
# Initialize git hooks
# This is for tracking the new commits
curl -s https://raw.githubusercontent.com/IonicaBizau/git-stats/master/scripts/init-git-post-commit | bash
@ -241,10 +242,14 @@ Cygwin Terminal is known to work, while Windows Command Prompt and Git Bash do n
## :clipboard: Example
Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm`:
Here is an example how to use this package as library. To install it locally, as library, you can do that using `npm` (or `yarn`):
```sh
$ npm i --save git-stats
# Using npm
npm install --save git-stats
# Using yarn
yarn add git-stats
```

2
package-lock.json generated
View file

@ -1,6 +1,6 @@
{
"name": "git-stats",
"version": "2.10.8",
"version": "2.10.9",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View file

@ -286,4 +286,4 @@
"bloggify.json",
"bloggify/"
]
}
}