From b1899460f01e603539f860775299b40cbf1bca07 Mon Sep 17 00:00:00 2001 From: tiagosiebler Date: Tue, 27 Jun 2023 11:16:31 +0100 Subject: [PATCH] chore(): readme notes on browser usage --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc83d5e..13c1098 100644 --- a/README.md +++ b/README.md @@ -329,15 +329,43 @@ In rare situations, you may want to see the raw HTTP requets being built as well ## Browser Usage +### Import + +This is the "modern" way, allowing the package to be directly imported into frontend projects with full typescript support. + +1. Install these dependencies + ```sh + npm install crypto-browserify stream-browserify + ``` +2. Add this to your `tsconfig.json` + ```json + { + "compilerOptions": { + "paths": { + "crypto": [ + "./node_modules/crypto-browserify" + ], + "stream": [ + "./node_modules/stream-browserify" + ] + } + ``` +3. Declare this in the global context of your application (ex: in polyfills for angular) + ```js + (window as any).global = window; + ``` + +### Webpack + +This is the "old" way of using this package on webpages. This will build a minified js bundle that can be pulled in using a script tag on a website. + Build a bundle using webpack: - `npm install` - `npm build` - `npm pack` -The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO. - -However, note that browser usage will lead to CORS errors due Bybit. See [issue #79](#79) for more information & alternative suggestions. +The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO - contributions welcome. ---