Skip to content

Commit 87d4621

Browse files
committed
feat: update package.json for optional webpack dependencies and add webpack configuration for bundling
1 parent 45a60d3 commit 87d4621

File tree

5 files changed

+1270
-109
lines changed

5 files changed

+1270
-109
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ privaterepotracker
66
restClientRegex.ts
77
testfile.ts
88
dist
9-
repomix.sh
9+
repomix.sh
10+
doc

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Complete JavaScript & Node.js SDK for BitMart REST APIs & WebSockets:
5656
- [Configuration Options](#configuration-options)
5757
- [Recv Window](#recv-window)
5858
- [Custom Sign](#custom-sign)
59+
- [Browser/Frontend Usage](#browserfrontend-usage)
60+
- [Webpack](#webpack)
5961
- [Related Projects](#related-projects)
6062
- [Structure](#structure)
6163
- [LLMs & AI](#use-with-llms--ai)
@@ -399,6 +401,18 @@ Authentication involves HMAC signing on requests using API credentials. Internal
399401

400402
Refer to the [fasterHmacSign.ts](./examples/fasterHmacSign.ts) example for a complete demonstration.
401403

404+
## Browser/Frontend Usage
405+
406+
### Webpack
407+
408+
Build a bundle using webpack:
409+
410+
- `npm install`
411+
- `npm run build`
412+
- `npm run pack`
413+
414+
The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.
415+
402416
## Use with LLMs & AI
403417

404418
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.

0 commit comments

Comments
 (0)