@pathmx/mermaid 0.5.0 → 0.5.1

package/README.md

@@ -1,23 +1,38 @@
-# @pathmx/mermaid
+# `@pathmx/mermaid`
 
-Opt-in Mermaid diagram rendering for PathMX. The base package accepts any
-renderer; the `beautiful` subpath supplies the pinned Beautiful Mermaid
-adapter and loads it only when a Mermaid fence is compiled.
+Opt-in Mermaid diagram rendering for PathMX.
+
+## Install
+
+```sh
+bun run pmx plugins add mermaid
+```
+
+Activate the ready-to-use Beautiful Mermaid renderer:
 
 ```ts
-import { BeautifulMermaidPlugin } from "@pathmx/mermaid/beautiful"
-import { PathMX } from "@pathmx/core/bun"
-import { defaultPlugins } from "@pathmx/core/plugins"
+// plugins/mermaid.plugin.ts
+export { BeautifulMermaidPlugin as default } from "@pathmx/mermaid/beautiful"
+```
+
+Then author ordinary Mermaid code fences:
 
-const app = await PathMX({
-  plugins: [BeautifulMermaidPlugin, ...defaultPlugins],
-})
+````md
+```mermaid
+flowchart LR
+  Source --> Plugin --> View
 ```
+````
+
+The renderer loads only when a Source contains a Mermaid fence. Diagrams use
+the active PathMX theme and include a larger-view control.
+
+## Custom renderer
 
-Use a custom renderer through the base entrypoint:
+Use the base package when another renderer should produce the SVG:
 
 ```ts
 import { MermaidPlugin } from "@pathmx/mermaid"
 
-const plugin = () => MermaidPlugin(async (code) => renderDiagram(code))
+export default () => MermaidPlugin(async (code) => renderDiagram(code))
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pathmx/mermaid",
   "description": "Mermaid diagram plugins and renderers for PathMX.",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
     "type": "git",