From 11c37ae51314883befe0493c43860437441c4103 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Sun, 24 Dec 2017 22:15:21 +0200 Subject: [PATCH] Updated docs --- README.md | 9 +++++++-- package-lock.json | 2 +- package.json | 2 +- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index df5ecee..2026c8e 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/package-lock.json b/package-lock.json index 82bd150..5f9d420 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "git-stats", - "version": "2.10.8", + "version": "2.10.9", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 7f95a08..da1f6d0 100644 --- a/package.json +++ b/package.json @@ -286,4 +286,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}