morffy 0.1.0 → 0.2.0

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/README.md CHANGED
@@ -4,8 +4,6 @@ A read-only visualizer that shows how a system-architecture diagram **evolves
4
4
  over a timeline**. It pairs a Visio-style graph canvas with a Gantt-style
5
5
  timeline, both driven by a single AI-generated JSON/YAML file.
6
6
 
7
- See [`SPEC.md`](SPEC.md) for the full design.
8
-
9
7
  ## Running the app
10
8
 
11
9
  There are two ways to view a diagram.
@@ -25,38 +23,7 @@ The CLI serves the app and **auto-loads** the given file. It also **watches the
25
23
  file** — edit it on disk and the diagram refreshes on screen automatically
26
24
  (disable with `--no-watch`).
27
25
 
28
- > [!IMPORTANT]
29
- > **The CLI serves a built app, so a build must exist first.**
30
- > When you install the published npm package this is already done for you — it
31
- > ships a prebuilt `dist/`, so `npx morffy diagram.json` just works.
32
- >
33
- > When working **from this repo**, build first (the CLI will tell you if you
34
- > forget):
35
- >
36
- > ```sh
37
- > npm run serve -- diagram.json # build, then serve (one step)
38
- > # or, if dist/ is already built:
39
- > npm run serve:built -- diagram.json # serve without rebuilding
40
- > ```
41
- >
42
- > Note: the CLI watches your **diagram file**, not the app source. After editing
43
- > app source, rebuild (`npm run build`) to see those changes. For live app-source
44
- > reloading, use the Vite dev server (`npm run dev`) instead.
45
-
46
- ## Development
47
-
48
- ```sh
49
- npm install
50
- npm run dev # vite dev server (http://localhost:5173)
51
- ```
52
-
53
- ### Quality gate
54
-
55
- ```sh
56
- npm run typecheck # tsc -b --noEmit
57
- npm test # vitest (unit + CLI integration)
58
- npm run test:e2e # playwright
59
- npm run lint # eslint
60
- npm run build # tsc -b && vite build
61
- npm run format # prettier --write
62
- ```
26
+ > [!NOTE]
27
+ > The published package ships a prebuilt app, so `npx morffy diagram.json` just
28
+ > works no build step. The CLI watches your **diagram file** and refreshes the
29
+ > diagram on every change.