@miragari/client 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +19 -5
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @miragari/client
2
2
 
3
- Stateless client SDK for routing media generation requests across provider
3
+ Stateless client runtime for routing media generation requests across provider
4
4
  plugins.
5
5
 
6
6
  ## Install
@@ -9,14 +9,28 @@ plugins.
9
9
  npm install @miragari/client
10
10
  ```
11
11
 
12
+ ## What this package includes
13
+
14
+ - request normalization
15
+ - provider registry
16
+ - async polling and wait helpers
17
+ - image batch splitting
18
+ - profile and defaults support
19
+
20
+ ## Typical use case
21
+
22
+ Use `@miragari/client` when you want the router runtime without the built-in
23
+ providers. If you want the batteries-included entrypoint, prefer
24
+ `@miragari/providers`.
25
+
12
26
  ## Example
13
27
 
14
28
  ```ts
15
29
  import { MediaRouter } from "@miragari/client"
16
30
  ```
17
31
 
18
- Most users should prefer `@miragari/providers`, which ships the built-in
19
- provider plugins and `createMediaRouter()` convenience factory.
32
+ ## Related docs
20
33
 
21
- Project docs and end-to-end examples live in the repository root:
22
- [mediaRouter](https://github.com/Zehight/mediaRouter).
34
+ - Repository overview: <https://github.com/Zehight/mediaRouter>
35
+ - English docs: <https://github.com/Zehight/mediaRouter/blob/main/docs/en/getting-started.md>
36
+ - 中文文档: <https://github.com/Zehight/mediaRouter/blob/main/docs/zh-CN/getting-started.md>
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@miragari/client",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Client SDK for routing media generation requests across provider plugins.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./dist/index.d.ts",
8
- "license": "UNLICENSED",
8
+ "license": "MIT",
9
9
  "author": "Zehight",
10
10
  "homepage": "https://github.com/Zehight/mediaRouter#readme",
11
11
  "repository": {
@@ -39,7 +39,7 @@
39
39
  }
40
40
  },
41
41
  "dependencies": {
42
- "@miragari/core": "0.1.0"
42
+ "@miragari/core": "0.1.1"
43
43
  },
44
44
  "scripts": {
45
45
  "build": "tsc -p tsconfig.json",