@orkestrel/rater 0.0.12 → 0.0.14

package/README.md

@@ -1,13 +1,17 @@
 # @orkestrel/rater
 
-A typed **quantitative rating layer** over [`@orkestrel/reason`](https://github.com/orkestrel/reason):
-authored **lines** — each a plain reason `QuantitativeDefinition` joined to display
-metadata — are rated against a **subject** (a plain data record) to produce a
-`LineResult` per line (an `amount` plus its `Worksheet` audit trail) and one
-`RatingResult` (every line's outcome plus a derived `total`). The caller decides
-which lines to rate; `Rater` only evaluates what it is given. Rating never mutates
-its inputs — every result is a fresh object. Environment-agnostic — no I/O, no
-browser or server assumptions. Part of the `@orkestrel` line.
+> A typed quantitative rating layer over `@orkestrel/reason`'s shared engine: authored
+> lines, each a plain reason `QuantitativeDefinition` joined to display metadata, rated
+> against one subject to produce a `LineResult` per line — an `amount` and its
+> `Worksheet` audit trail — and one `RatingResult` carrying every line's outcome and a
+> derived `total`.
+
+Create a rater with the `createRater` function, hand it the lines a subject is rated
+against, and read the `LineResult` rows and the `total` it derives. Inject a
+[`@orkestrel/reason`](https://github.com/orkestrel/reason) `ReasonInterface` where the
+rating shares an engine with the rest of your reasoning, and call `destroy()` when the
+rater's work is done. Environment-agnostic — no I/O, no browser or server assumptions.
+Part of the `@orkestrel` line.
 
 ## Install
 
@@ -17,22 +21,26 @@ npm install @orkestrel/rater
 
 ## Requirements
 
-- Node.js >= 24
-- ESM (`import`) and CommonJS (`require`) via the `exports` field
+- Node.js >= 22.12.0
+- ESM (`import`) and CommonJS (`require`) through the `exports` field
 
 ## Usage
 
 ```ts
-import { createRater, lineDefinition } from '@orkestrel/rater'
-import { factorGroup, quantitativeDefinition, staticFactor } from '@orkestrel/reason'
+import { buildLineDefinition, createRater } from '@orkestrel/rater'
+import {
+	createFactorGroup,
+	createQuantitativeDefinition,
+	createStaticFactor,
+} from '@orkestrel/reason'
 
 const rater = createRater()
 
-const base = lineDefinition(
+const base = buildLineDefinition(
 	'base',
 	'Base Amount',
-	quantitativeDefinition('base', 'Base', [
-		factorGroup('amount', 'sum', [staticFactor('flat', 100)]),
+	createQuantitativeDefinition('base', 'Base', [
+		createFactorGroup('amount', 'sum', [createStaticFactor('flat', 100)]),
 	]),
 )
 
@@ -46,14 +54,14 @@ rater.destroy()
 ```
 
 `rate` accepts a plain `LineDefinition[]` or a full `RatingDefinition` plus one
-subject — both overloads rate a single subject. Every `rate` call fires once
+subject, and each overload rates that single subject. Every `rate` call fires once
 through `rater.emitter` (`rate`).
 
 ## Guide
 
 For the full surface — `Rater`, `RatingResult`, worksheet types, validators,
 factories, errors, and options — see
-[`guides/src/rater.md`](guides/src/rater.md).
+[`guides/rater.md`](guides/rater.md).
 
 ## Package