From 50fc33c10c0984ce3f22d88d73ed97f302e1f796 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Sun, 13 Dec 2020 18:29:11 +0000 Subject: [PATCH] clean docs + add webpack note --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0ac7d7c..2495348 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,6 @@ A production-ready Node.js connector for the Bybit APIs and WebSockets. ## Installation `npm install --save bybit-api` -## Usage -Create API credentials at Bybit -- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1) -- [Testnet](https://testnet.bybit.com/app/user/api-management) - ## Issues & Discussion - Issues? Check the [issues tab](https://github.com/tiagosiebler/bybit-api/issues). - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram. @@ -30,6 +25,19 @@ This project uses typescript. Resources are stored in 3 key structures: - [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. - [dist](./dist) - the packed bundle of the project for use in browser environments. +## Usage +Create API credentials at Bybit +- [Livenet](https://bybit.com/app/user/api-management?affiliate_id=9410&language=en-US&group_id=0&group_type=1) +- [Testnet](https://testnet.bybit.com/app/user/api-management) + +### Browser Usage +Build a bundle using webpack: +- `npm install` +- `npm build` +- `npm pack` + +The bundle can be found in `lib/`. Altough usage should be largely consistent, smaller differences will exist. Docs TBC. + ### Inverse Contracts #### Rest client ```javascript