@aerostack/sdk-web 0.3.2 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,25 +48,25 @@ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https
|
|
|
48
48
|
### NPM
|
|
49
49
|
|
|
50
50
|
```bash
|
|
51
|
-
npm add
|
|
51
|
+
npm add @aerostack/sdk-web
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
### PNPM
|
|
55
55
|
|
|
56
56
|
```bash
|
|
57
|
-
pnpm add
|
|
57
|
+
pnpm add @aerostack/sdk-web
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
### Bun
|
|
61
61
|
|
|
62
62
|
```bash
|
|
63
|
-
bun add
|
|
63
|
+
bun add @aerostack/sdk-web
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
### Yarn
|
|
67
67
|
|
|
68
68
|
```bash
|
|
69
|
-
yarn add
|
|
69
|
+
yarn add @aerostack/sdk-web
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
> [!NOTE]
|
|
@@ -411,7 +411,7 @@ You can override the default server globally by passing a server index to the `s
|
|
|
411
411
|
|
|
412
412
|
| # | Server | Description |
|
|
413
413
|
| --- | ----------------------------- | ----------------- |
|
|
414
|
-
| 0 | `https://api.aerostack.
|
|
414
|
+
| 0 | `https://api.aerostack.dev/v1` | Production |
|
|
415
415
|
| 1 | `http://localhost:8787/v1` | Local Development |
|
|
416
416
|
|
|
417
417
|
#### Example
|
|
@@ -536,6 +536,26 @@ const sdk = new SDK({ debugLogger: console });
|
|
|
536
536
|
```
|
|
537
537
|
<!-- End Debugging [debug] -->
|
|
538
538
|
|
|
539
|
+
|
|
540
|
+
## Browser-Only Usage
|
|
541
|
+
|
|
542
|
+
> **SDK Type**: HTTP Client (Browser)
|
|
543
|
+
|
|
544
|
+
This SDK is designed **exclusively for browser environments**:
|
|
545
|
+
|
|
546
|
+
✅ **Use for**:
|
|
547
|
+
- Vanilla JavaScript/TypeScript web apps
|
|
548
|
+
- Single-page applications (SPAs)
|
|
549
|
+
- Client-side authentication and API calls
|
|
550
|
+
|
|
551
|
+
❌ **Not for**:
|
|
552
|
+
- Node.js backends (use `@aerostack/node` instead)
|
|
553
|
+
- Server-side rendering (use `@aerostack/node` for SSR data fetching)
|
|
554
|
+
- Cloudflare Workers (use `@aerostack/sdk` instead)
|
|
555
|
+
|
|
556
|
+
**For React apps**, use `@aerostack/react` which provides hooks and context.
|
|
557
|
+
**For server-side code**, use `@aerostack/node`.
|
|
558
|
+
|
|
539
559
|
# Development
|
|
540
560
|
|
|
541
561
|
## Maturity
|