@miragari/core 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 +13 -6
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @miragari/core
2
2
 
3
- Shared protocol and validation types for MediaRouter.
3
+ Shared protocol and validation layer for MediaRouter.
4
4
 
5
5
  ## Install
6
6
 
@@ -8,14 +8,21 @@ Shared protocol and validation types for MediaRouter.
8
8
  npm install @miragari/core
9
9
  ```
10
10
 
11
- ## Exports
11
+ ## What this package includes
12
12
 
13
13
  - request and result types
14
14
  - provider plugin contracts
15
15
  - dimension helpers
16
- - validation and normalized error helpers
16
+ - validation helpers
17
+ - normalized error primitives
17
18
 
18
- ## Docs
19
+ ## Typical use case
19
20
 
20
- Project docs and higher-level SDK examples live in the repository root:
21
- [mediaRouter](https://github.com/Zehight/mediaRouter).
21
+ Use this package when you are building your own router shell, provider plugin,
22
+ or internal tooling on top of MediaRouter concepts.
23
+
24
+ ## Related docs
25
+
26
+ - Repository overview: <https://github.com/Zehight/mediaRouter>
27
+ - English docs: <https://github.com/Zehight/mediaRouter/blob/main/docs/en/getting-started.md>
28
+ - 中文文档: <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/core",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Shared protocol, validation, and provider types for MediaRouter.",
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": {