@quo-systems/quo 0.2.9 → 0.2.11

package/README.md

@@ -25,8 +25,8 @@ types nowhere under `node_modules`.
 
 ```
 src/being/        the Being side: what a being author imports, if anything
-src/ward/         the ward: door, seal, arithmetic, heirs, stance, allowance
-src/harbor/       the Ground contract, MemoryHarbor, and the harbor core with its store and reach
+src/ward/         the ward: the Ground contract, door, seal, arithmetic, heirs, stance, allowance
+src/harbor/       MemoryHarbor, and the harbor core with its store, reach and dialer
 src/conformance/  behaviours any ward must show, written against the truth
 test/             the suites
 vectors/          fixed inputs and outputs, so another language proves its bytes
@@ -42,13 +42,19 @@ chromium` once. A terrain whose binary is missing skips and says so.
 
 ## Check
 
+The gate lives at the root of the repository this package is developed in,
+and runs from there:
+
 ```
 npm run check
 ```
 
-Typecheck, lint, then tests. The pieces run alone too: `npm run typecheck`,
-`npm run lint` (`lint:ts` is oxlint with type-aware rules, `lint:md` is
-markdownlint), `npm run lint:fix`, and `npm test`.
+Build, typecheck, lint, then the suites of every package. The pieces run
+alone there too: `npm run typecheck`, `npm run lint` (`lint:ts` is oxlint
+with type-aware rules, `lint:md` is markdownlint), `npm run lint:fix`, and
+`npm test`. Inside this package three scripts exist and no more: `npm test`
+runs the suites under `test/`, `npm run build` emits `dist/`, and
+`npm run check:terrain` runs the terrains.
 
 The toolchain is TypeScript 7, the native compiler, and oxlint, which is the
 linter built for it. Both are in Rust or Go rather than JavaScript, so the
@@ -73,7 +79,9 @@ vectors are the byte-level hand, everything a stranger can observe:
 Ed25519, X25519, HKDF and AES-256-GCM; `vectors/framing.json`, Quo's own,
 the ward pk, the digest, the signed ask body, the sealed shapes, the
 invitation and the knock; `vectors/wire.json`, the frames on a socket and
-the one request a door takes. A kit reproduces them or it is not this
+the one request a door takes. They import by name,
+`@quo-systems/quo/vectors/framing.json`, so a kit's own suite can read them
+from the package. A kit reproduces them or it is not this
 protocol. `src/conformance/` is the behavioural hand, and it is a checklist
 a kit ports, not a harness it runs: the beings it is shown with run only in
 a TypeScript ward. `SPEC.md` "The tree" says the whole of it.
@@ -83,10 +91,11 @@ a TypeScript ward. `SPEC.md` "The tree" says the whole of it.
 Published from 0.1.0, the first version under this name, with no
 compatibility promise before 1.0.0: the words may still move. `npm pack
 --dry-run` shows what ships: the emitted `dist/`, the source, the vectors,
-the spec, and the licence — no tests, no configs. The spec ships because it
-is the truth the source and the vectors are read against. `npm publish`
-runs both gates first, `check` and `check:terrain`, and refuses on a
-failure.
+the spec, this file, the licence and the notice, and no tests and no
+configs. The spec ships because it is the truth the source and the vectors
+are read against. Publishing is gated from the root of the repository:
+`npm run release` there runs both gates, `check` and `check:terrain`, and
+publishes on green; `npm publish` inside this package refuses and says so.
 
 ## License