Skip to content

Commit

Permalink
chore(): doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagosiebler committed Dec 22, 2023
1 parent 5a7337b commit 45705c0
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Check out my related projects:

Most methods accept JS objects. These can be populated using parameters specified by Bybit's API documentation, or check the type definition in each class within the github repository (see table below for convenient links to each class).

- [Bybit API Docs (choose API category from the tabs at the top)](https://bybit-exchange.github.io/docs/v5/intro).
- [Bybit API Docs](https://bybit-exchange.github.io/docs/v5/intro)
- [TSDoc Documentation (generated using typedoc via npm module)](https://tsdocs.dev/docs/bybit-api)

## Structure

Expand Down Expand Up @@ -242,6 +243,8 @@ The following API groups are still available in the WebsocketClient but are depr
---
### WebSocket Examples
Here's a minimal example for using the websocket client. For more complete examples, look into the ws-\* examples in the [examples](./examples/) folder in the repo on GitHub.
```javascript
Expand Down

0 comments on commit 45705c0

Please sign in to comment.