@telepath-computer/television 0.1.21 → 0.1.23

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
@@ -8,57 +8,38 @@ Requirements:
8
8
  - Node.js 18+ (Node 22 recommended)
9
9
  - npm
10
10
 
11
- ### Install & run (desktop app)
11
+ ### Desktop app (Electron)
12
12
 
13
13
  ```bash
14
14
  npm install
15
- npm run start
15
+ npm run start:electron
16
16
  ```
17
17
 
18
- `npm run start` builds and launches Electron, and also starts the server at `http://localhost:32848`.
18
+ Starts Vite HMR for the renderer and launches Electron. Changes to renderer code and CSS update live. Changes to Electron main process or server code require restarting.
19
19
 
20
- ### Install & run (standalone server + browser)
21
-
22
- Build the standalone artifacts, link the CLI locally, and start the standalone
23
- server:
20
+ ### Standalone server (browser)
24
21
 
25
22
  ```bash
26
23
  npm install
27
- npm run build
28
- npm link
29
- tv serve
24
+ npm run start:server
30
25
  ```
31
26
 
32
- Then open the printed server URL in a browser. When the built renderer bundle is
33
- present, `tv serve` serves the browser UI from `dist/browser/`.
27
+ Starts Vite HMR for the renderer, the Television server, and an artifact runtime watcher. Open the printed URL in a browser.
34
28
 
35
- Built artifact runtimes used by iframes are also produced during `npm run build`, including:
29
+ ### CLI
36
30
 
37
- - `dist/artifact-runtime/`
38
-
39
- ### Install & run (standalone server + CLI)
40
-
41
- Build the CLI, link it locally, and start the standalone server:
31
+ Build and link the CLI, then use it against a running server:
42
32
 
43
33
  ```bash
44
- npm install
45
34
  npm run build
46
35
  npm link
47
36
  tv serve
48
- ```
49
-
50
- In another terminal, use the CLI against the running server:
51
-
52
- ```bash
53
37
  tv status
54
38
  tv list-workspaces
55
39
  tv create-artifact --title "hello" --content "world"
56
40
  ```
57
41
 
58
- ### Run as a system service
59
-
60
- Once the CLI is built and linked, you can install Television as a background
61
- service so it starts automatically:
42
+ ### System service
62
43
 
63
44
  ```bash
64
45
  tv serve --persist
@@ -66,28 +47,6 @@ tv status
66
47
  tv stop
67
48
  ```
68
49
 
69
- ### Development
70
-
71
- For development with hot reload, use the dev server:
72
-
73
- ```bash
74
- npm run dev
75
- ```
76
-
77
- This starts a Vite dev server for the shared renderer in `src/browser/` with HMR, so changes to renderer code and CSS will update live without restarting. Changes to Electron main process code in `src/electron/`, the server, or CLI require restarting.
78
-
79
- The dev script also watches and rebuilds the iframe-facing artifact runtime bundle.
80
-
81
- ### Layout demo
82
-
83
- To experiment with generic `layout-view` behavior (grid sizes, drag reorder, local persistence) without the main app:
84
-
85
- ```bash
86
- npm run layout
87
- ```
88
-
89
- Then open the printed URL (default dev server port `5174`). See `docs/layout/` for how layout rendering relates to `Workspace.layout` in production.
90
-
91
50
  ### Verification
92
51
 
93
52
  Use these commands depending on how much coverage you want:
@@ -95,7 +54,8 @@ Use these commands depending on how much coverage you want:
95
54
  ```bash
96
55
  npm run test:setup # one-time Playwright browser install
97
56
  npm test # Vitest unit/integration tests
98
- npm run test:e2e # Playwright browser/e2e tests (Chromium)
57
+ npm run test:e2e-browser # Playwright browser e2e tests (Chromium)
58
+ npm run test:e2e-node # server e2e tests
99
59
  npm run test:electron # built Electron smoke test
100
60
  npm run test:all # all tests
101
61
  npm run verify # lint + type-check + all tests