@orkestrel/brief 0.0.6 → 0.0.8

package/README.md

@@ -1,32 +1,44 @@
 # @orkestrel/brief
 
-A synchronous, deterministic specification compiler. A rough request compiles into a
-`Brief` — a closed, JSON-serializable execution contract another agent can run with no
-interpretation left to do — and every downstream artifact (the prompt a model reads, a
-completion condition, a subagent dispatch) is projected from that one source of truth.
+> The specification compiler: a synchronous, deterministic pipeline that resolves a rough
+> request into a `Brief` — a closed, content-hashed execution contract another agent can run
+> with no interpretation left to do — gated by a traceable reasoner and projected into every
+> downstream artifact.
 
-A brief with blocking gaps never emits. The readiness gate is a `@orkestrel/reason`
-`LogicalDefinition`, so every verdict carries a traceable account of which check missed.
+Compile a request with the `createBriefCompiler` factory, read the `Briefing` it returns, and
+project the brief it carries into the prompt a model reads, a completion condition, or a
+subagent dispatch. A brief with blocking gaps never emits: the readiness gate is a
+`@orkestrel/reason` `LogicalDefinition`, so every verdict carries a traceable account of which
+check missed. Part of the `@orkestrel` line.
+
+## Install
 
 ```sh
 npm install @orkestrel/brief
 ```
 
+## Requirements
+
+- Node.js >= 22.12.0, matching the `engines` field in `package.json`
+- ESM and CommonJS entry points, selected by the `exports` field in `package.json`
+
+## Usage
+
 ```ts
 import {
 	createBriefCompiler,
 	briefToGoal,
 	briefToMarkdown,
-	outcome,
-	proof,
-	task,
+	buildOutcome,
+	buildProof,
+	buildTask,
 } from '@orkestrel/brief'
 
 const compiler = createBriefCompiler()
 const briefing = compiler.compile({
-	task: task('refactor', 'code', 'Refactor useForm to native browser form APIs.'),
-	outcomes: [outcome(1, 'useForm uses native FormData with no behavior change')],
-	proofs: [proof('type-check and lint pass', 'npm run check')],
+	task: buildTask('refactor', 'code', 'Refactor useForm to native browser form APIs.'),
+	outcomes: [buildOutcome(1, 'useForm uses native FormData with no behavior change')],
+	proofs: [buildProof('type-check and lint pass', 'npm run check')],
 })
 
 if (briefing.brief !== undefined) {
@@ -36,6 +48,8 @@ if (briefing.brief !== undefined) {
 compiler.destroy()
 ```
 
+## Guide
+
 Full documentation: [`guides/brief.md`](guides/brief.md). The guides index lives at
 [`guides/README.md`](guides/README.md).