@demlik/tea 0.12.0 → 0.14.0

package/README.md

@@ -18,7 +18,8 @@ utilities).
 
 A machine is plain data: an `init`, an `update` map keyed by `Msg` type, and —
 when it has effects — an `interpret` map. `run` drives it; `dispatch` folds a
-`Msg`; `getState` reads the current Model.
+`Msg`; `getState` reads the current Model. You name the Model and the `Msg` union
+once, under `types`; everything else is inferred from the machine itself.
 
 ```ts
 import { defineMachine, run } from "@demlik/tea";
@@ -26,7 +27,8 @@ import { defineMachine, run } from "@demlik/tea";
 type State = { readonly count: number };
 type Msg = { readonly type: "increment" } | { readonly type: "reset" };
 
-const counter = defineMachine<State, Msg, never, never, unknown>({
+const counter = defineMachine({
+  types: { model: {} as State, msg: {} as Msg },
   init: (loaded) => (loaded !== null ? [loaded, []] : [{ count: 0 }, []]),
   update: {
     increment: (s) => [{ count: s.count + 1 }, []],
@@ -41,13 +43,13 @@ runtime.getState(); // { count: 1 }
 
 ## Documentation
 
-The four Diátaxis quadrants live in [`docs/`](./docs/README.md):
+The four Diátaxis quadrants live in [`docs/`](https://github.com/kamp-us/demlik/blob/main/docs/README.md):
 
-- [Tutorials](./docs/tutorial/index.md) — learning-oriented lessons that take you through the library by building a real machine.
-- [How-to guides](./docs/how-to/index.md) — goal-oriented directions for getting a specific job done.
-- [Reference](./docs/reference/index.md) — information-oriented API description, generated per public module.
-- [Explanation](./docs/explanation/index.md) — understanding-oriented discussion of how it works and why it is shaped this way.
+- [Tutorials](https://github.com/kamp-us/demlik/blob/main/docs/tutorial/index.md) — learning-oriented lessons that take you through the library by building a real machine.
+- [How-to guides](https://github.com/kamp-us/demlik/blob/main/docs/how-to/index.md) — goal-oriented directions for getting a specific job done.
+- [Reference](https://github.com/kamp-us/demlik/blob/main/docs/reference/index.md) — information-oriented API description, generated per public module.
+- [Explanation](https://github.com/kamp-us/demlik/blob/main/docs/explanation/index.md) — understanding-oriented discussion of how it works and why it is shaped this way.
 
 Two more surfaces sit behind those, for people working on the library rather than using it:
-[`.patterns/`](./.patterns/index.md) is how the code is shaped, and
-[`.decisions/`](./.decisions/index.md) is why it was shaped that way.
+[`.patterns/`](https://github.com/kamp-us/demlik/blob/main/.patterns/index.md) is how the code is shaped, and
+[`.decisions/`](https://github.com/kamp-us/demlik/blob/main/.decisions/index.md) is why it was shaped that way.