vizmatic 0.1.3 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/PROMPT.md CHANGED
@@ -2,10 +2,18 @@
2
2
 
3
3
  Use Vizmatic to create polished, theme-aware diagrams, figures, dashboards, presentation frames, and animated GIFs from structured React scene primitives.
4
4
 
5
- ## Install
5
+ ## Install Or Run
6
6
 
7
7
  Use the package manager already present in the project.
8
8
 
9
+ For one-off renders, use the binary without changing `package.json`:
10
+
11
+ ```bash
12
+ pnpm dlx vizmatic ./frame.tsx --out ./dist/frames --theme dark,light
13
+ ```
14
+
15
+ Install when the project needs scripts, editor types, or direct renderer APIs:
16
+
9
17
  ```bash
10
18
  pnpm add vizmatic react
11
19
  ```
@@ -106,7 +114,7 @@ export default frame.default
106
114
  Render it:
107
115
 
108
116
  ```bash
109
- pnpm exec vizmatic render frames --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right
117
+ pnpm exec vizmatic frames --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right
110
118
  ```
111
119
 
112
120
  Frame modules can also export a watermark element when code-owned branding is clearer than CLI flags:
package/README.md CHANGED
@@ -31,6 +31,16 @@
31
31
 
32
32
  ## Quick Start
33
33
 
34
+ Use Vizmatic as a one-off binary without touching `package.json`:
35
+
36
+ ```bash
37
+ pnpm dlx vizmatic ./frame.tsx --out ./dist/frames --theme dark,light
38
+ ```
39
+
40
+ Frame files can import `react` and `vizmatic`; the CLI resolves those from its own package runtime in `dlx`/`npx` mode.
41
+
42
+ Install it when you want project scripts, editor types, or direct renderer APIs:
43
+
34
44
  ```bash
35
45
  pnpm add vizmatic react
36
46
  ```
@@ -70,7 +80,7 @@ export default frame.default
70
80
  Render it:
71
81
 
72
82
  ```bash
73
- vizmatic render ./frame.tsx --out ./dist/frames --theme dark,light --watermark "Acme" --watermark-image ./logo.svg
83
+ vizmatic ./frame.tsx --out ./dist/frames --theme dark,light --watermark "Acme" --watermark-image ./logo.svg
74
84
  ```
75
85
 
76
86
  Render an animation:
@@ -378,7 +388,7 @@ git diff --exit-code
378
388
 
379
389
  ## Supply Chain Posture
380
390
 
381
- Vizmatic keeps runtime dependencies narrow: `satori` for JSX layout, `@resvg/resvg-js` for rasterization, `gifenc` for animated GIF output, and `tsx` so the CLI can load TSX scene files directly.
391
+ Vizmatic keeps runtime dependencies narrow: `react` for JSX frames, `satori` for JSX layout, `@resvg/resvg-js` for rasterization, `gifenc` for animated GIF output, and `tsx` so the CLI can load TSX scene files directly.
382
392
 
383
393
  Package resolution is intentionally conservative:
384
394
 
@@ -564,7 +574,7 @@ src/
564
574
  render.ts Satori -> SVG -> resvg -> PNG
565
575
  animate.ts ordered scene states -> GIF
566
576
  autocrop.ts content bounds and overflow checks
567
- cli.ts vizmatic render / vizmatic gif
577
+ cli.ts vizmatic file.tsx / vizmatic render / vizmatic gif
568
578
  examples/
569
579
  *.tsx generated gallery frames
570
580
  docs/