@stream-mdx/protocol 0.2.0 → 0.4.0

package/README.md

@@ -5,3 +5,31 @@ Protocol types for StreamMDX JSON/object streaming.
 This package defines the event envelope, capability metadata, and token
 structures used by StreamMDX Protocol v1. It is intended for consumers that
 need a stable, versioned contract (e.g., terminal UIs).
+
+Most web-only consumers do not need this package directly. Start with `stream-mdx`
+or `@stream-mdx/react` for the React renderer.
+
+## Install
+
+```bash
+npm install @stream-mdx/protocol
+```
+
+## What this provides
+
+- Shared protocol types for streaming events and capability negotiation.
+- Token / block payload shapes intended for structured-clone-safe transport.
+
+## Typical usage (TUI/CLI)
+
+Pair it with `@stream-mdx/tui` for NDJSON helpers + a lightweight snapshot store:
+
+```bash
+npm install @stream-mdx/tui @stream-mdx/protocol @stream-mdx/core
+```
+
+## Docs
+
+- Public API: https://github.com/kmccleary3301/stream-mdx/blob/main/docs/PUBLIC_API.md
+- 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

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
-export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
+export { DiffBlock, DiffKind, DiffLine, DiffLineKind, ThemedLine, ThemedToken, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
 
 declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
 declare const STREAM_MDX_SCHEMA_VERSION = "1.0";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Block, Patch, PatchMetrics } from '@stream-mdx/core';
-export { DiffKind, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
+export { DiffBlock, DiffKind, DiffLine, DiffLineKind, ThemedLine, ThemedToken, TokenLineV1, TokenSpan, TokenStyle } from '@stream-mdx/core';
 
 declare const STREAM_MDX_PROTOCOL_ID = "streammdx";
 declare const STREAM_MDX_SCHEMA_VERSION = "1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-mdx/protocol",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "StreamMDX protocol types and event envelope for JSON/object streaming",
   "license": "MIT",
   "repository": {
@@ -34,6 +34,6 @@
     "prepack": "npm run build"
   },
   "dependencies": {
-    "@stream-mdx/core": "0.2.0"
+    "@stream-mdx/core": "0.4.0"
   }
 }