Skip to content
This repository has been archived by the owner on Jan 20, 2020. It is now read-only.

Commit

Permalink
Add deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
mihar committed Jul 18, 2016
1 parent e614fa2 commit b8347ef
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Coinbase Exchange
# DEPRECATED

This package has been deprecated and will receive any further updates.

Please use the new official client [gdax-node](https://github.com/coinbase/gdax-node).

# Coinbase Exchange
The official Node.js library for the [GDAX
API](https://docs.gdax.com/) (formerly Coinbase Exchange).

Expand Down Expand Up @@ -210,7 +216,7 @@ authedClient.cancelOrders(callback);
// `cancelAllOrders` will handle making these requests for you asyncronously.
// Also you can add a product_id param to only delete orders of that product

// The response will be the response of the last call and the data will
// The response will be the response of the last call and the data will
// have the order ID's of all your deleted orders
authedClient.cancelAllOrders({product_id: 'BTC-USD'}, callback);
```
Expand Down Expand Up @@ -265,8 +271,13 @@ authedClient.withdraw(withdrawParamsBTC, callback);
```

### Websocket client
The `WebsocketClient` allows you to connect and listen to the
[exchange websocket messages](https://docs.gdax.com/#messages).
<<<<<<< e614fa20dfbc8ce07ff909ddfd96e559f8925ffd
The `WebsocketClient` allows you to connect and listen to the
[exchange websocket messages](https://docs.gdax.com/#messages).
=======
The `WebsocketClient` allows you to connect and listen to the
[exchange websocket messages](https://docs.exchange.coinbase.com/#messages).
>>>>>>> Add deprecation notice
```javascript
var CoinbaseExchange = require('coinbase-exchange');
var websocket = new CoinbaseExchange.WebsocketClient();
Expand All @@ -277,7 +288,7 @@ The following events can be emitted from the `WebsocketClient`:
* `message`
* `close`

### Orderbook
### Orderbook
`Orderbook` is a data structure that can be used to store a local copy of the orderbook.
```javascript
var CoinbaseExchange = require('coinbase-exchange');
Expand Down

0 comments on commit b8347ef

Please sign in to comment.