@kairos-es/read 0.0.0 → 1.0.0-alpha.0

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 +11 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -13,6 +13,17 @@ decider-level retry for `AppendConditionFailed` (ADR-0008), is a **write**-side
13
13
  combinator and lives in [`@kairos-es/core`](../core) beside the error it matches,
14
14
  so retrying your own appends never means depending on this package.
15
15
 
16
+ ## Installation
17
+
18
+ `@kairos-es/core`, `@kairos-es/codec` and `effect` are peer dependencies, so the
19
+ application owns the single shared Effect instance (per
20
+ [ADR-0003](../../docs/adr)). The codec is required rather than optional: this
21
+ package value-imports it.
22
+
23
+ ```sh
24
+ pnpm add @kairos-es/read@alpha @kairos-es/codec@alpha @kairos-es/core@alpha effect
25
+ ```
26
+
16
27
  ## Wiring a read model
17
28
 
18
29
  A read model is a view store bound to the `CheckpointKey` it advances
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kairos-es/read",
3
- "version": "0.0.0",
3
+ "version": "1.0.0-alpha.0",
4
4
  "description": "Query-driven projection runner and checkpoint port for kairos-es",
5
5
  "license": "BSD-3-Clause",
6
6
  "repository": {
@@ -12,8 +12,8 @@
12
12
  "homepage": "https://github.com/neverbland/kairos-es",
13
13
  "peerDependencies": {
14
14
  "effect": "^3.22.0",
15
- "@kairos-es/codec": "^0.0.0",
16
- "@kairos-es/core": "^0.0.0"
15
+ "@kairos-es/codec": "^1.0.0-alpha.0",
16
+ "@kairos-es/core": "^1.0.0-alpha.0"
17
17
  },
18
18
  "main": "./dist/cjs/index.js",
19
19
  "module": "./dist/esm/index.js",