@stream-mdx/tui 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,4 +1,24 @@
 # Changelog
 
+## 0.5.0
+
+### Minor Changes
+
+- Promote the current hardening and product-surface tranche as `0.5.0`.
+
+  This release rolls up:
+
+  - renderer/store correctness hardening
+  - seeded smoke and scheduler-parity release discipline
+  - benchmark methodology and comparison cleanup
+  - docs, showcase, and TUI/product surface maturation
+
+### Patch Changes
+
+- Updated dependencies
+  - @stream-mdx/core@0.5.0
+  - @stream-mdx/protocol@0.5.0
+
 ## 0.1.1
+
 - Initial release with NDJSON helpers and snapshot store.

package/README.md

@@ -1,17 +1,23 @@
-# @stream-mdx/tui
+# `@stream-mdx/tui`
 
-Reference utilities for terminal and CLI integrations.
-
-## Features
-- NDJSON encoder/decoder helpers for StreamMDX protocol events.
-- Lightweight snapshot store that applies patches and yields blocks.
+`@stream-mdx/tui` provides terminal-oriented helpers for StreamMDX protocol streams: NDJSON encoding/decoding and a lightweight snapshot store that can apply events and materialize blocks outside React.
 
 ## Install
+
 ```bash
-npm install @stream-mdx/tui @stream-mdx/core @stream-mdx/protocol
+npm install @stream-mdx/tui @stream-mdx/protocol @stream-mdx/core
 ```
 
-## NDJSON
+## Main Capabilities
+
+| Capability | Notes |
+| --- | --- |
+| NDJSON helpers | Encode/decode protocol events for line-oriented transports |
+| Snapshot store | Apply patch streams and recover block state |
+| Non-React usage | Useful in TUIs, CLIs, log viewers, and replay tools |
+
+## NDJSON Example
+
 ```ts
 import { NdjsonDecoder, encodeNdjsonEvent } from "@stream-mdx/tui";
 
@@ -20,7 +26,8 @@ const chunk = encodeNdjsonEvent({ event: "done" } as any);
 const events = decoder.push(chunk);
 ```
 
-## Snapshot Store
+## Snapshot Store Example
+
 ```ts
 import { createSnapshotStore } from "@stream-mdx/tui";
 
@@ -30,11 +37,16 @@ const blocks = store.getBlocks();
 ```
 
 ## Notes
-- Token output is gated by the worker output mode ("tokens" or "both").
-- The store is intended for non-React environments (TUIs, CLIs).
 
-## Docs
+- Token output depends on the worker output mode (`tokens` or `both`).
+- The store is intentionally lightweight and aimed at non-React consumers.
+
+## Documentation
 
-- CLI usage: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/CLI_USAGE.md
-- Protocol spec: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/STREAMMDX_JSON_DIFF_SPEC.md
-- Public API: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/PUBLIC_API.md
+- Run the example locally with `npm run example:tui-minimal` from the repo root.
+- [`../../examples/tui-minimal/README.md`](../../examples/tui-minimal/README.md)
+- [`../../docs/TUI_MINIMAL_EXAMPLE.md`](../../docs/TUI_MINIMAL_EXAMPLE.md)
+- [`../../docs/TUI_GUIDE.md`](../../docs/TUI_GUIDE.md)
+- [`../../docs/CLI_USAGE.md`](../../docs/CLI_USAGE.md)
+- [`../../docs/STREAMMDX_JSON_DIFF_SPEC.md`](../../docs/STREAMMDX_JSON_DIFF_SPEC.md)
+- [`../../docs/PUBLIC_API.md`](../../docs/PUBLIC_API.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-mdx/tui",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "StreamMDX TUI helpers (NDJSON parsing and snapshot store)",
   "license": "MIT",
   "repository": {
@@ -34,7 +34,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@stream-mdx/core": "0.4.0",
-    "@stream-mdx/protocol": "0.4.0"
+    "@stream-mdx/core": "0.5.0",
+    "@stream-mdx/protocol": "0.5.0"
   }
 }