Update README.md

jscriptcoder · web-flow · commit 84e67fc6996b · 2020-10-19T21:09:49.000+02:00
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Gymie - Client
 
+<a href="https://www.npmjs.com/package/gymie"><img alt="npm" src="https://img.shields.io/npm/v/gymie?label=NPM%20Package" /></a>
+
 <table>
   <tbody>
     <tr>
@@ -20,6 +22,31 @@
 
 ## Installation
 
+Gymie-client is available as a [NPM package](https://www.npmjs.com/package/gymie), and can installed as a dependency as usual:
+
+```bash
+$ npm install gymie
+```
+
+You can also clone the repo and npm-link the library as follow:
+
+```bash
+$ git clone https://github.com/jscriptcoder/Gymie-Client
+Cloning into 'Gymie-Client'...
+...
+
+$ cd Gymie-Client/
+$ npm link
+gymie@0.x.y preinstall /path/to/Gymie-Client
+...
+
+$ cd ~/path/to/project
+$ npm link gymie
+/path/to/project/node_modules/gymie -> /usr/local/lib/node_modules/gymie -> /path/to/Gymie-Client
+```
+
+Although there isn't really a good readon to do it this way, unless you wanna contribute to the library and test it locally.
+
 ## How to run the client
 
 ## API and how to use it
