From b961b5ab274f3eb2e811aa0bc1f20d5e2de01fa2 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Wed, 31 Aug 2022 18:03:46 +0100 Subject: [PATCH] readme updates --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 98bb8f3..352e6b5 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Check out my related projects: - [ftx-api](https://www.npmjs.com/package/ftx-api) - [bybit-api](https://www.npmjs.com/package/bybit-api) - [binance](https://www.npmjs.com/package/binance) + - [okx-api](https://www.npmjs.com/package/okx-api) - Try my misc utilities: - [orderbooks](https://www.npmjs.com/package/orderbooks) - Check out my examples: @@ -50,9 +51,10 @@ Each REST API category has a dedicated REST client. Here are the REST clients an | Derivatives V3 unified margin | Under Development | ## Structure -This project uses typescript. Resources are stored in 3 key structures: -- [src](./src) - the whole connector written in typescript -- [lib](./lib) - the javascript version of the project (compiled from typescript). This should not be edited directly, as it will be overwritten with each release. +The connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bybit-api). This connector is fully compatible with both TypeScript and pure JavaScript projects. + +- [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. - [dist](./dist) - the packed bundle of the project for use in browser environments. - [examples](./examples) - some implementation examples & demonstrations. Contributions are welcome!