release-readme: the root README written last, honestly — crate family table with per-engine honest postures (ADR-016 compile-time identity, deployment.md as the boundary), mem-carried usage sketch compile-checked and executed against the real API, contract-suite pointer (three engines, one pinned contract), license note; LICENSE-MIT + LICENSE-APACHE per the family pattern (substrate notice untouched per ADR-018); CHANGELOG seeded with the 0.1.0 contract-v1 entry; per-crate readme wiring decided + landed (pointer-style per-crate readmes, readme fields wired on the four published crates); honesty trace list in task Notes; task -> completed
This commit is contained in:
1 parent
f5e0e8e199
commit
260fb31707
13 files changed
+599
-2
No files matched your search
@@ -4,6 +4,7 @@ version.workspace = true
|
||||
edition.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
readme = "README.md"
|
||||
|
||||
[dependencies]
|
||||
serde = "1"
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# alkstore
|
||||
|
||||
The core crate of the [alkstore](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
|
||||
family: the contract artifact — the unified `Store` trait surface,
|
||||
value types, error taxonomy, and the naming / reserved-namespace
|
||||
contract of the reactive store substrate. It has no driver
|
||||
dependencies, ever (payload encoding's `serde`/`serde_json` are its
|
||||
only dependencies); engine crates depend on it and implement its
|
||||
traits.
|
||||
|
||||
Downstream consumers depend on `alkstore` plus exactly one engine
|
||||
crate: [`alkstore-sqlite`](https://crates.io/crates/alkstore-sqlite),
|
||||
[`alkstore-postgres`](https://crates.io/crates/alkstore-postgres), or
|
||||
[`alkstore-mem`](https://crates.io/crates/alkstore-mem). Engine
|
||||
identity is compile-time — the engine crate your binary depends on
|
||||
*is* the deployment statement; there is no runtime capability surface.
|
||||
|
||||
See the [family README](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
|
||||
for the interface, the engine postures, and the deployment matrix;
|
||||
the crate's own docs are part of the contract.
|
||||
Reference in new issue
Block a user