Skip to content

Commit

Permalink
Merge pull request #2 from sketchthat/feature/npm-release
Browse files Browse the repository at this point in the history
Feature/npm release
  • Loading branch information
sketchthat committed May 11, 2018
2 parents 8416b17 + ad34370 commit 80efc36
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 8 additions & 3 deletions README.md
Expand Up @@ -19,7 +19,13 @@ In order to utilise the `trading-api` you'll need to generate an [API Key](https

## Usage

The API wrapper exposes a [Data](https://docs.exchange.coinjar.com/data-api/) and a [Trading](https://docs.exchange.coinjar.com/trading-api/) method.
The API wrapper exposes a [Data](https://docs.exchange.coinjar.com/data-api/) and a [Trading](https://docs.exchange.coinjar.com/trading-api/) method, which contain each of the endpoint functions.

### Exposed Functions
- [Trading](https://github.com/sketchthat/coinjarexchange/wiki/Trading-Methods) methods are within [`trading.ts`](https://github.com/sketchthat/coinjarexchange/blob/master/src/trading.ts)
- [Data](https://github.com/sketchthat/coinjarexchange/wiki/Data-Methods) methods are within [`data.ts`](https://github.com/sketchthat/coinjarexchange/blob/master/src/data.ts)

### Example

```typescript
import { CoinJarExchange } from 'coinjarexchange';
Expand Down Expand Up @@ -79,5 +85,4 @@ cje.trading().getFills()
*/
```

- [Trading](https://github.com/sketchthat/coinjarexchange/blob/master/src/trading.ts) methods are within `trading.ts`
- [Data](https://github.com/sketchthat/coinjarexchange/blob/master/src/data.ts) methods are within `data.ts`

11 changes: 10 additions & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "coinjarexchange",
"version": "1.0.0",
"version": "1.0.1",
"description": "Typescript wrapper for CoinJar Exchange",
"main": "dist/index.js",
"scripts": {
Expand All @@ -14,6 +14,15 @@
"type": "git",
"url": "git+https://github.com/sketchthat/coinjarexchange.git"
},
"keywords": [
"coinjar",
"exchange",
"api",
"bitcoin",
"ethereum",
"ripple",
"litecoin"
],
"author": "Michael Kimpton",
"license": "WTFPL",
"bugs": {
Expand Down

0 comments on commit 80efc36

Please sign in to comment.