code/bybit-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme formatting

Browse Source
This commit is contained in:
tiagosiebler
2021-03-06 18:07:20 +00:00
parent a18730870b
commit 755f60abaa
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -26,12 +26,14 @@ This project uses typescript. Resources are stored in 3 key structures:
- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. - [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release.
- [dist](./dist) - the packed bundle of the project for use in browser environments. - [dist](./dist) - the packed bundle of the project for use in browser environments.
## Usage ---
# Usage
Create API credentials at Bybit Create API credentials at Bybit
- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1) - [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
- [Testnet](https://testnet.bybit.com/app/user/api-management) - [Testnet](https://testnet.bybit.com/app/user/api-management)
### REST API Clients ## REST API Clients
There are three REST API modules as there are some differences in each contract type. There are three REST API modules as there are some differences in each contract type.
1. `InverseClient` for inverse perpetual 1. `InverseClient` for inverse perpetual
@@ -268,7 +270,7 @@ See [websocket-client.ts](./src/websocket-client.ts) for further information.
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. 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.
### Customise Logging ## 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. 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.
<details><summary>Click here to expand and see full sample:</summary> <details><summary>Click here to expand and see full sample:</summary>
@@ -287,7 +289,7 @@ const ws = new WebsocketClient(
</details> </details>
### Browser Usage ## Browser Usage
Build a bundle using webpack: Build a bundle using webpack:
- `npm install` - `npm install`
- `npm build` - `npm build`