Skip to content

Commit f59ed00

Browse files
committed
feat(): add TOC
1 parent 40233d4 commit f59ed00

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,33 @@ Updated & performant JavaScript & Node.js SDK for the Binance REST APIs and WebS
5252
- Proxy support via axios integration.
5353
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
5454

55+
## Table of Contents
56+
57+
- [Installation](#installation)
58+
- [Examples](#examples)
59+
- [REST API Examples](./examples/REST)
60+
- [WebSocket Examples](./examples/WebSockets)
61+
- [WebSocket Consumers](./examples/WebSockets/todo:)
62+
- [WebSocket API](./examples/WebSockets/wsapitodo:)
63+
- [Issues & Discussion](#issues--discussion)
64+
- [Related Projects](#related-projects)
65+
- [Documentation Links](#documentation)
66+
- [Usage](#usage)
67+
- [REST API Clients](#rest-api-clients)
68+
- [REST Main Client](#rest-main-client)
69+
- [REST USD-M Futures](#rest-usd-m-futures)
70+
- [REST COIN-M Futures](#rest-coin-m-futures)
71+
- [WebSockets](#websockets)
72+
- [WebSocket Consumers](#websocket-consumers)
73+
- [WebSocket API](#websocket-api)
74+
- [Event Driven API](#event-driven-api)
75+
- [Promise Driven API](#async-await-api)
76+
- [Customise Logging](#customise-logging)
77+
- [Frontend Usage](#browserfrontend-usage)
78+
- [Import](#import)
79+
- [Webpack](#webpack)
80+
- [Contributions & Thanks](#contributions--thanks)
81+
5582
## Installation
5683

5784
`npm install binance --save`
@@ -413,7 +440,7 @@ The WebSocket API is available in the [WebsocketClient](./src/websocket-client.t
413440
414441
Each call to this method is wrapped in a promise, which you can async await for a response, or handle it in a raw event-driven design.
415442
416-
#### REST-Like Await API
443+
#### Async Await API
417444
418445
The WebSocket API is also available in a promise-wrapped REST-like format. Either, as above, await any calls to `sendWSAPIRequest(...)`, or directly use the convenient WebsocketAPIClient. This class is very similar to existing REST API classes (such as the MainClient or USDMClient).
419446

0 commit comments

Comments
 (0)