From db9ff36478eac5846bf38a73928efb45f9077fa2 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Sat, 6 Mar 2021 18:00:07 +0000 Subject: [PATCH] readme cleaning --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2696bf4..92783b4 100644 --- a/README.md +++ b/README.md @@ -110,8 +110,6 @@ client.getOrderBook({ symbol: 'BTCUSD' }) See [inverse-client.ts](./src/inverse-client.ts) for further information. ## Inverse Futures Contracts -**Note**: as of 6th March 2021 this is currently only for testnet. See the [Bybit API documentation](https://bybit-exchange.github.io/docs/inverse_futures/#t-introduction) for official updates. -
To use the inverse futures REST APIs, import the `InverseFuturesClient`. Click here to expand and see full sample: ```javascript @@ -153,6 +151,8 @@ client.getOrderBook({ symbol: 'BTCUSDH21' }) See [inverse-futures-client.ts](./src/inverse-futures-client.ts) for further information. +**Note**: as of 6th March 2021 this is currently only for testnet. See the [Bybit API documentation](https://bybit-exchange.github.io/docs/inverse_futures/#t-introduction) for official updates. + ## Linear Contracts
To use the Linear (USDT) REST APIs, import the `LinearClient`. Click here to expand and see full sample: @@ -194,12 +194,7 @@ client.getOrderBook({ symbol: 'BTCUSDT' })
## WebSockets - -Inverse & linear WebSockets can be used via a shared `WebsocketClient`. - -Note: for linear websockets, pass "linear: true" in the constructor options when instancing the `WebsocketClient`. - -
To connect to both linear and inverse websockets, make two instances of the WebsocketClient. Click here to expand and see full sample: +
Inverse & linear WebSockets can be used via a shared `WebsocketClient`. Click here to expand and see full sample: ```javascript const { WebsocketClient } = require('bybit-api'); @@ -277,12 +272,11 @@ ws.on('error', err => {
+Note: for linear websockets, pass "linear: true" in the constructor options when instancing the `WebsocketClient`. To connect to both linear and inverse websockets, make two instances of the WebsocketClient. See [websocket-client.ts](./src/websocket-client.ts) for further information. ### Customise Logging -Pass a custom logger which supports the log methods `silly`, `debug`, `notice`, `info`, `warning` and `error`, or override methods from the default logger as desired: - -
Click here to expand and see full sample: +
Pass a custom logger which supports the log methods `silly`, `debug`, `notice`, `info`, `warning` and `error`, or override methods from the default logger as desired. Click here to expand and see full sample: ```javascript const { WebsocketClient, DefaultLogger } = require('bybit-api');