Skip to content

Commit

Permalink
docs(README): added installation instructions and unify style
Browse files Browse the repository at this point in the history
  • Loading branch information
niklas-dahl authored Sep 6, 2017
1 parent 816fa67 commit c465660
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,15 @@ Node Kraken

NodeJS Client Library for the Kraken (kraken.com) API

This is an asynchronous node js client for the kraken.com API. It exposes all the API methods found here: https://www.kraken.com/help/api through the ```api``` method:
This is an asynchronous node js client for the kraken.com API. It exposes all the API methods found here: https://www.kraken.com/help/api through the ```api``` method.

Example Usage:
### Installation

```bash
npm install kraken-api
```

### Example Usage:

```javascript
const key = '...'; // API Key
Expand All @@ -22,7 +28,7 @@ const kraken = new KrakenClient(key, secret);
})();
```

**Updates:**
### Updates:

As of version 1.0.0:
- All methods return a promise.
Expand All @@ -39,7 +45,7 @@ function(error, data) {

Thanks to @tehsenaus and @petermrg for pointing this out.

Credit:
### Credit:

I used the example php implementation at https://github.com/payward/kraken-api-client and the python implementation at https://github.com/veox/python3-krakenex as references.

Expand Down

0 comments on commit c465660

Please sign in to comment.