Updated docs

IonicaBizau · Dec 24, 2017 · b90edae · b90edae
1 parent b1538a1
commit b90edae
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@
 *.log
 node_modules
 *.env
+.DS_Store
+package-lock.json
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
 <!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
+
 [![github-stats](http://i.imgur.com/1cEkaOy.png)](#)
 
 # `$ github-stats`
 
- [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/github-stats.svg)](https://www.npmjs.com/package/github-stats) [![Downloads](https://img.shields.io/npm/dt/github-stats.svg)](https://www.npmjs.com/package/github-stats)
+ [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/github-stats.svg)](https://www.npmjs.com/package/github-stats) [![Downloads](https://img.shields.io/npm/dt/github-stats.svg)](https://www.npmjs.com/package/github-stats)
 
 > Visualize stats about GitHub users and projects in your terminal.
 
@@ -22,7 +23,11 @@ You can install the package globally and use it as command line tool:
 
 
 ```sh
-$ npm i -g github-stats
+# Using npm
+npm install --global github-stats
+
+# Using yarn
+yarn global add github-stats
 ```
 
 
@@ -58,10 +63,14 @@ Documentation can be found at https://github.com/IonicaBizau/gh-stats
 ## :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 github-stats
+# Using npm
+npm install --save github-stats
+
+# Using yarn
+yarn add github-stats
 ```
 
 
@@ -103,9 +112,11 @@ There are few ways to get help:
 
  1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. :bug:
+
  3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
 
 
+
 ## :memo: Documentation
 
 For full API reference, see the [DOCUMENTATION.md][docs] file.
@@ -122,6 +133,7 @@ this takes time. You can integrate and use these projects in your applications *
 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:
 
  - Starring and sharing the projects you like :rocket:
+ - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
  - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
  - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
  - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -69,4 +69,4 @@
     "bloggify.json",
     "bloggify/"
   ]
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -69,4 +69,4 @@ @@
         "bloggify.json",
         "bloggify/"
       ]
-    }
+    }