crypto-exchange-manager - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

package.json

 {
   "name": "crypto-exchange-manager",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Wrapper for cryptocurrencies exchanges apis.",
@@ -8,3 +8,3 @@ "main": "index.js",
     "type": "git",
-    "url": "git+https://github.com/azukaar/crypto-manager"
+    "url": "git+https://github.com/azukaar/crypto-exchange-manager"
   },
@@ -11,0 +11,0 @@ "scripts": {

readme.md

@@ -27,3 +27,3 @@ [![CircleCI](https://circleci.com/gh/azukaar/crypto-exchange-manager.svg?style=svg)](https://circleci.com/gh/azukaar/crypto-exchange-manager)
 const cryptoManager = require('crypto-exchange-manager');
-const polynex = cryptoManager['polynex'];
+const polynex = new cryptoManager['polynex']();
 
@@ -48,3 +48,3 @@ polynex.getPairs()
 const cryptoManager = require('crypto-exchange-manager');
-const polynex = cryptoManager['polynex'];
+const polynex = new cryptoManager['polynex']();
 
@@ -73,1 +73,70 @@ polynex.tick('BCN_BTC')
 ```
+
+**Authenticate user
+
+```
+Currently supported : 
+  - bifinex
+```
+
+```js
+const cryptoManager = require('crypto-exchange-manager');
+const bifinex = new cryptoManager['bifinex']({
+  key: '123',
+  secret: '123'
+});
+```
+
+**get wallet
+
+```
+Currently supported : 
+  - bifinex
+```
+
+```js
+const cryptoManager = require('crypto-exchange-manager');
+const bifinex = new cryptoManager['bifinex']({
+  key: '123',
+  secret: '123'
+});
+
+bifinex.getWallet().then(result => {
+  console.log(result);
+})
+```
+
+Will return an array of currencies with their value in the wallet.
+
+```
+[
+  {currency: 'ETH', wallet: '1.8'}
+]
+```
+
+**get wallet
+
+```
+Currently supported : 
+  - bifinex
+```
+
+```js
+const cryptoManager = require('crypto-exchange-manager');
+const bifinex = new cryptoManager['bifinex']({
+  key: '123',
+  secret: '123'
+});
+
+bifinex.getBook('ETH').then(result => {
+  console.log(result);
+})
+```
+
+Will return an array of movement in / out of the account of the user for a specific currency.
+
+```
+[
+  {currency: 'ETH', value: '1.8', completed: true, issued: '154787488'}
+]
+```

No alert changes

Improved metrics

Total package byte prevSize

24266

increased by4.65%

Number of lines in readme file

139

increased by95.77%

No dependency changes