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

Commit b8347ef

Browse files
committed
Add deprecation notice
1 parent e614fa2 commit b8347ef

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Coinbase Exchange
1+
# DEPRECATED
2+
3+
This package has been deprecated and will receive any further updates.
4+
5+
Please use the new official client [gdax-node](https://github.com/coinbase/gdax-node).
6+
7+
# Coinbase Exchange
28
The official Node.js library for the [GDAX
39
API](https://docs.gdax.com/) (formerly Coinbase Exchange).
410

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

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

267273
### Websocket client
268-
The `WebsocketClient` allows you to connect and listen to the
269-
[exchange websocket messages](https://docs.gdax.com/#messages).
274+
<<<<<<< e614fa20dfbc8ce07ff909ddfd96e559f8925ffd
275+
The `WebsocketClient` allows you to connect and listen to the
276+
[exchange websocket messages](https://docs.gdax.com/#messages).
277+
=======
278+
The `WebsocketClient` allows you to connect and listen to the
279+
[exchange websocket messages](https://docs.exchange.coinbase.com/#messages).
280+
>>>>>>> Add deprecation notice
270281
```javascript
271282
var CoinbaseExchange = require('coinbase-exchange');
272283
var websocket = new CoinbaseExchange.WebsocketClient();
@@ -277,7 +288,7 @@ The following events can be emitted from the `WebsocketClient`:
277288
* `message`
278289
* `close`
279290

280-
### Orderbook
291+
### Orderbook
281292
`Orderbook` is a data structure that can be used to store a local copy of the orderbook.
282293
```javascript
283294
var CoinbaseExchange = require('coinbase-exchange');

0 commit comments

Comments
 (0)