@zombie-mermaid/svg-renderer 2.2.6 → 3.1.0

package/README.md

@@ -5,22 +5,42 @@
 
 SVG layout and rendering primitives for [Mermaid](https://mermaid.js.org/) diagrams — the [ELK.js](https://github.com/kieler/elkjs)-backed layout engine and per-diagram-type SVG emitters behind [`zombie-mermaid`](https://www.npmjs.com/package/zombie-mermaid)'s SVG output.
 
-## What this package is (and isn't)
-
-**Just want SVG output from Mermaid text?** Use [`zombie-mermaid`](https://www.npmjs.com/package/zombie-mermaid)'s `renderMermaidSVG(text)` instead — it's simpler and does exactly that.
-
-This package does **not** currently include that single entry point. It exports the lower-level pieces the umbrella assembles it from: a `layout*Sync()` function and a `render*Svg()` function per diagram type (flowchart/state, class, ER, sequence, XY chart), plus the shared ELK.js adapter and layout engine underneath them. Diagram-type dispatch (detecting which diagram type a given Mermaid source is, and routing to the right layout/render pair) still lives in the umbrella. Adding a `renderMermaidSVG` front door here, for parity with `@zombie-mermaid/ascii-renderer`, is tracked separately — see [zombie-mermaid#1111](https://github.com/dfadler/zombie-mermaid/issues/1111).
-
-Reach for this package directly if you're doing custom integration work — a different dispatch layer, a subset of diagram types, or reusing the ELK.js layout adapters for something else — and want to skip the umbrella package's own dispatch and ASCII-rendering code.
+Supports flowcharts, state diagrams, sequence diagrams, class diagrams, ER diagrams, and XY charts.
 
 ## Install
 
 ```bash
-npm install @zombie-mermaid/svg-renderer @zombie-mermaid/mermaid-parser @zombie-mermaid/core
+npm install @zombie-mermaid/svg-renderer
 ```
 
 ## Usage
 
+```ts
+import { renderMermaidSVG } from '@zombie-mermaid/svg-renderer'
+
+const svg = renderMermaidSVG('graph LR\n  A --> B')
+console.log(svg)
+```
+
+```ts
+const text = 'graph LR\n  A --> B'
+
+renderMermaidSVG(text, {
+  bg: '#1a1b26', // background color
+  fg: '#a9b1d6', // foreground/text/line color
+  font: 'Inter',
+  transparent: false,
+  embedSource: true, // stamp the original text onto the root <svg> as data-src
+  title: 'Flowchart: A to B', // accessible name (role="img" + aria-labelledby)
+})
+```
+
+See `RenderOptions` in [`@zombie-mermaid/core`](https://www.npmjs.com/package/@zombie-mermaid/core) for the full option set. Need async? Use `renderMermaidSVGAsync()` — same output, returns a `Promise<string>`.
+
+## Lower-level pieces
+
+This package also exports the per-diagram-type building blocks `renderMermaidSVG` is assembled from — a `layout*Sync()` function and a `render*Svg()` function per diagram type (flowchart/state, class, ER, sequence, XY chart), plus the shared ELK.js adapter and layout engine underneath them. Reach for these directly if you're doing custom integration work — a different dispatch layer, a subset of diagram types, or reusing the ELK.js layout adapters for something else — and want to skip diagram-type detection.
+
 Each diagram type follows the same shape: parse (from `@zombie-mermaid/mermaid-parser`) → lay out → render. Class diagrams, for example:
 
 ```ts