markstream-angular 0.0.2 → 0.0.5

package/README.md

@@ -1,6 +1,15 @@
-# markstream-angular
+# markstream-angular — Angular streaming Markdown renderer for AI chat
 
-Angular version of Markstream: a streaming-friendly Markdown renderer with KaTeX, Mermaid, Monaco code blocks, D2, infographic blocks, custom HTML tags, and cross-framework playground parity.
+Angular 20+ standalone component for streaming Markdown: AI chat, LLM token streams, SSE/WebSocket output, incomplete Markdown states, long documents, Mermaid, KaTeX, Monaco code blocks, D2, infographic blocks, custom HTML tags, and cross-framework playground parity.
+
+## When to use it
+
+Use `markstream-angular` when Markdown streams from an LLM, SSE, or WebSocket into an Angular 20+ standalone app.
+For short static Markdown, a completed-document Markdown renderer or a simpler parser is usually enough.
+
+## Status
+
+This package is currently alpha. Treat it as a streaming Markdown integration surface to evaluate in your Angular app, not as the most stable package in the Markstream family. Check npm and the [Angular guide](https://markstream.simonhe.me/guide/angular-quick-start) for the latest API maturity.
 
 ## Install
 
@@ -16,6 +25,8 @@ Optional peer dependencies:
 - `@terrastruct/d2` for D2 diagrams
 - `@antv/infographic` for infographic blocks
 
+Install only the peers your output actually needs. Plain Markdown does not require Mermaid, KaTeX, Monaco, D2, or Infographic.
+
 Example:
 
 ```bash
@@ -96,9 +107,7 @@ In this monorepo:
 - Angular regression lab: `http://127.0.0.1:4175/test`
 - Angular version sandbox: `http://127.0.0.1:4175/test-sandbox`
 
-## Status
-
-This package is still tagged `alpha`, but the current direction is already aligned with `markstream-react` / `markstream-vue2` for:
+Current development is aligned with `markstream-react` / `markstream-vue2` for:
 
 - node-component renderer structure
 - streaming code block behavior