From cf61a444581b7b620dfe05234130b82ac3964891 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Tue, 4 Mar 2025 11:43:15 +0000 Subject: [PATCH] chore(): readme updates --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e6447bf..9738108 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,12 @@ Professional Node.js, JavaScript & TypeScript SDK for the Bybit REST APIs and We - [Related Projects](#related-projects) - [Documentation](#documentation) -## Structure & Usage -- [Structure](#structure) +## REST API Examples & Usage Guidance +- [Detailed Examples](#examples) - [API Clients](#api-clients) -- [REST API USAGE](#rest-api-usage) +- [REST API Usage](#rest-api-usage) -## WebSocket Integration +## WebSocket Integration & Examples - [WebSockets](#websockets) - [WebSocket Subscriptions - Consuming Events](#websocket-subscriptions---consuming-events) - [Websocket API - Sending Orders via WebSockets](#websocket-api---sending-orders-via-websockets) @@ -131,6 +131,8 @@ The SDK is written in TypeScript, but fully compatible with both TypeScript and --- +## Examples + Examples for using each client can be found in: - the [examples](./examples) folder.