Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added installation instructions and unify style #44

Merged
merged 1 commit into from
May 16, 2020
Merged

added installation instructions and unify style #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
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