From 63547848c971ad7f247297ceb151e1f67fa66ce7 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Sat, 17 Sep 2022 11:40:05 +0100 Subject: [PATCH] readme phrasing --- README.md | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a834bb2..de793b1 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ Most methods accept JS objects. These can be populated using parameters specifie - [Bybit API Docs (choose API category from the tabs at the top)](https://bybit-exchange.github.io/docs/futuresV2/inverse/#t-introduction). ## Structure -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, while 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. The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended). +The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended). - [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. diff --git a/package.json b/package.json index badb8e5..8eaf14a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bybit-api", - "version": "2.4.0-beta.2", + "version": "3.0.0", "description": "Node.js connector for Bybit's REST APIs and WebSockets, with TypeScript & integration tests.", "main": "lib/index.js", "types": "lib/index.d.ts",