Merge pull request #95 from JJ-Cro/webpack

feat: add Webpack configuration and update README for browser usage

Author: tiagosiebler

.gitignore

@@ -25,6 +25,7 @@ dist
 coverage
 localtest.sh
 repomix.sh
+doc
 
 ws-private-spot-wsapi-performance.ts
 ws-private-perp-futures-wsapi-readonly.ts
@@ -33,4 +34,4 @@ privatetest.ts
 privaterepotracker
 restClientRegex.ts
 
-testfile.ts
+testfile.ts

README.md

@@ -63,6 +63,8 @@ Updated & performant JavaScript & Node.js SDK for the Gate.com (gate.io) REST AP
       - [Event Driven API](#event-driven-api)
       - [REST-like API](#rest-like-api)
 - [Customise Logging](#customise-logging)
+- [Browser/Frontend Usage](#browserfrontend-usage)
+  - [Webpack](#webpack)
 - [LLMs & AI](#use-with-llms--ai)
 - [Used By](#used-by)
 - [Contributions & Thanks](#contributions--thanks)
@@ -433,6 +435,18 @@ DefaultLogger.silly = () => {};
 const ws = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, DefaultLogger);
 ```
 
+## Browser/Frontend Usage
+
+### Webpack
+
+Build a bundle using webpack:
+
+- `npm install`
+- `npm run build`
+- `npm run pack`
+
+The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.
+
 ## Use with LLMs & AI
 
 This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.