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

readme tweaks

Browse Source
This commit is contained in:
tiagosiebler
2022-09-16 00:36:32 +01:00
parent 8813a968a6
commit 921152fa3b
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -11,8 +11,8 @@
Node.js connector for the Bybit APIs and WebSockets: Node.js connector for the Bybit APIs and WebSockets:
- Complete integration with all bybit APIs. - Complete integration with all bybit APIs.
- TypeScript support (with type declarations for most API requests & responses). - TypeScript support (with type declarations for most API requests & responses).
- Over 200 integration tests making real API calls, validating any changes before they reach npm. - Over 300 integration tests making real API calls & WebSocket connections, validating any changes before they reach npm.
- Robust WebSocket integration with connection heartbeats & automatic reconnection. - Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
- Browser support (via webpack bundle - see "Browser Usage" below). - Browser support (via webpack bundle - see "Browser Usage" below).
## Installation ## Installation
@@ -45,7 +45,7 @@ This connector is fully compatible with both TypeScript and pure JavaScript proj
- [src](./src) - the whole connector written in TypeScript - [src](./src) - the whole connector written in TypeScript
- [lib](./lib) - the JavaScript version of the project (built from TypeScript). This should not be edited directly, as it will be overwritten with each release. - [lib](./lib) - the JavaScript version of the project (built 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 web-packed bundle of the project for use in browser environments.
- [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome! - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!
--- ---