From 45705c0e79649d8cdfa2a5a5abe7d2c8ab33947e Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Fri, 22 Dec 2023 11:54:58 +0000 Subject: [PATCH] chore(): doc updates --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index da865615..4fbc7da5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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