docs: sync READMEs, remove json-cas-workflow references

This commit is contained in:
2026-05-25 10:27:59 +00:00
parent 0e38fd3ea9
commit 1dacd699d5
4 changed files with 16 additions and 21 deletions
-1
View File
@@ -10,7 +10,6 @@ Monorepo with 4 packages under `packages/`:
|---------|-------------|
| `json-cas` | Core CAS engine — hashing, schema, store, verify, bootstrap |
| `json-cas-fs` | Filesystem-backed CAS store |
| `json-cas-workflow` | Workflow integration layer (schemas + types) |
| `cli-json-cas` | CLI tool |
## Tech Stack
+14 -18
View File
@@ -8,33 +8,30 @@ json-cas is a monorepo for storing and validating JSON data in a content-address
A bootstrap meta-schema is stored as a self-referencing seed node (`type === hash`). All other schemas are registered as nodes typed by that meta-schema. Payloads can reference other nodes via `format: "cas_ref"` fields; the library provides traversal, reference extraction, and integrity verification.
Use the in-memory store for tests and embedded apps, the filesystem store for persistence, the workflow package for pre-built agent/workflow schemas, and the CLI for local store management.
Use the in-memory store for tests and embedded apps, the filesystem store for persistence, and the CLI for local store management.
## Architecture
```
┌─────────────────┐
│ cli-json-cas │
└────────┬────────┘
┌──────────────┴──────────────┐
▼ ▼
┌─────────────────┐ ┌──────────────────────┐
│ json-cas-fs │ │ json-cas-workflow │
└────────┬────────┘ └──────────┬───────────┘
│ │
└──────────────┬───────────────
─────────────────
│ json-cas │ (core)
└─────────────────┘
┌─────────────────┐
│ cli-json-cas │
└────────┬────────┘
┌─────────────────┐
│ json-cas-fs │
└────────┬────────┘
─────────────────┐
│ json-cas │ (core)
─────────────────
```
| Layer | Package | Role |
|-------|---------|------|
| Core | `@uncaged/json-cas` | Hashing, schemas, stores, verify, bootstrap |
| Storage | `@uncaged/json-cas-fs` | Filesystem-backed `Store` |
| Domain | `@uncaged/json-cas-workflow` | Workflow/agent JSON Schemas and payload types |
| CLI | `@uncaged/cli-json-cas` | `json-cas` command-line tool |
## Packages
@@ -43,7 +40,6 @@ Use the in-memory store for tests and embedded apps, the filesystem store for pe
|---------|-------------|------|
| [`@uncaged/json-cas`](packages/json-cas/README.md) | Core CAS engine — hashing, schema, store, verify, bootstrap | lib |
| [`@uncaged/json-cas-fs`](packages/json-cas-fs/README.md) | Filesystem-backed CAS store | lib |
| [`@uncaged/json-cas-workflow`](packages/json-cas-workflow/README.md) | Workflow integration layer (schemas + types) | lib |
| [`@uncaged/cli-json-cas`](packages/cli-json-cas/README.md) | CLI tool (`json-cas` binary) | cli |
## Quick Start
+1 -1
View File
@@ -24,7 +24,7 @@ Exported from `src/index.ts`:
function createFsStore(dir: string): BootstrapCapableStore;
```
`BootstrapCapableStore` is re-exported from `@uncaged/json-cas` (via the return type). The store loads existing `.bin` files on open and migrates or builds the type index on first use.
Returns a `BootstrapCapableStore` from `@uncaged/json-cas`. The store loads existing `.bin` files on open and migrates or builds the type index on first use.
### Example
+1 -1
View File
@@ -6,7 +6,7 @@ Core CAS engine — hashing, schema, store, verify, bootstrap.
`@uncaged/json-cas` is the foundation of the json-cas monorepo. It defines content-addressed nodes (`CasNode`), the `Store` interface, XXH64-based hashing with deterministic CBOR, JSON Schema registration and validation (including `cas_ref` links between nodes), bootstrap seeding, and integrity verification.
Other packages build on this layer: `json-cas-fs` provides persistence, `json-cas-workflow` registers domain schemas, and `cli-json-cas` exposes store operations on the command line.
Other packages build on this layer: `json-cas-fs` provides persistence, and `cli-json-cas` exposes store operations on the command line.
**Dependencies:** `ajv`, `cborg`, `xxhash-wasm`