From 65e885989b2ae56a11da727eb0232be43f32d9c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Wed, 16 Sep 2026 22:03:28 +0000 Subject: [PATCH] :memo: Backlog the README walkthrough restoration The example-code removal stripped the synopsis and examples with the template modules; track bringing them back around the real API, with the previous section order recorded so its placement is not re-guessed. --- backlog.tasks | 3 +++ 1 file changed, 3 insertions(+) diff --git a/backlog.tasks b/backlog.tasks index 69249df..448a052 100644 --- a/backlog.tasks +++ b/backlog.tasks @@ -34,6 +34,9 @@ Enhancements: ☐ Are there other primitive types that should be supported in union patterns? (e.g. `bigint`, `symbol`) @medium Documentation: +☐ Bring README.md back to its previous form — synopsis and examples restored, in the correct place + → previous section order: title, tagline, Synopsis, Description, Requirements, Examples, API, License, Contributing + → previous Examples order: literal/exhaustive, typeof, structural/discriminated unions, when, any ☐ Create `examples/` directory with runnable snippets ☐ Add comparison section vs. other TS pattern-matching libs in Readme.md ☐ Write migration guide for users coming from discriminated unions