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]
|
||||
alkstore = { version = "0.1", path = "../alkstore" }
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# alkstore-sqlite
|
||||
|
||||
The SQLite engine of the [alkstore](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
|
||||
family: the core contract implemented on rusqlite over the forked
|
||||
honker-core substrate carried in-tree.
|
||||
|
||||
```rust
|
||||
let store = alkstore_sqlite::open("store.db", alkstore_sqlite::SqliteOpts::default())?;
|
||||
```
|
||||
|
||||
**Engine posture — single-host, file-backed.** Cross-process on one
|
||||
host is verified territory; a `.db` on network storage (NFS
|
||||
two-writers) is not a supportable deployment posture. Durability
|
||||
knobs, pool sizing, and the watcher cadence are engine-configuration
|
||||
concerns on `SqliteOpts` — `synchronous = NORMAL` is hardwired at
|
||||
connection bootstrap; there is no consumer surface to raise the sync
|
||||
level.
|
||||
|
||||
See the [family README](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
|
||||
for the interface and the deployment matrix, and the
|
||||
[SQLite engine spec](https://git.alk.dev/alkdev/alkstore/blob/main/docs/architecture/engine-sqlite.md)
|
||||
for the substrate's details. The substrate (forked third-party code)
|
||||
ships with its own bundled license notice in the crate tree — the
|
||||
root dual license files do not replace it.
|
||||
Reference in new issue
Block a user