You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-46Lines changed: 7 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,63 +11,24 @@
11
11
12
12
Volt is a monorepo centered around the VoltX.js runtime—a lightweight, declarative alternative to component-centric UI frameworks. The repo also ships the Volt CLI and the documentation site that demonstrates and explains the runtime.
13
13
14
-
## Philosophy/Goals
14
+
## Local Development
15
15
16
-
- Behavior is declared via `data-volt-*` attributes.
17
-
- HTML drives the UI, not components.
18
-
- Core under **20 KB gzipped**, zero dependencies.
19
-
- Signals update the DOM directly without a virtual DOM.
20
-
- Native Server-Sent Events (SSE) and WebSocket patch updates.
| Signals | Reactive primitives that automatically update DOM bindings when changed. |
37
-
| Bindings |`data-volt-text`, `data-volt-html`, `data-volt-class` connect attributes or text to expressions. |
38
-
| Actions |`data-volt-on-click`, `data-volt-on-input`, etc. attach event handlers declaratively. |
39
-
| Streams |`data-volt-stream="/events"` listens for SSE or WebSocket updates and applies JSON patches. |
40
-
| Plugins | Modular extensions (`data-volt-persist`, `data-volt-surge`, `data-volt-shift`, etc.) to enhance the core. |
41
-
42
-
## VoltX.css
43
-
44
-
VoltX ships with an optional classless CSS framework inspired by Pico CSS and Tufte CSS. It provides beautiful, semantic styling for HTML elements without requiring any CSS classes—just write semantic markup and it looks great out of the box.
45
-
46
-
Features include typography with modular scale, Tufte-style sidenotes, styled form elements, dialogs, accordions, tooltips, tables, and more. See the framework's [README](./lib/README.md#voltxcss) for installation and usage details.
| Signals | Reactive primitives that automatically update DOM bindings when changed. |
49
+
| Bindings |`data-volt-text`, `data-volt-html`, `data-volt-class` connect attributes or text to expressions. |
50
+
| Actions |`data-volt-on-click`, `data-volt-on-input`, etc. attach event handlers declaratively. |
51
+
| Streams |`data-volt-stream="/events"` listens for SSE or WebSocket updates and applies JSON patches. |
52
+
| Plugins | Modular extensions (`data-volt-persist`, `data-volt-surge`, `data-volt-shift`, etc.) to enhance the core. |
53
+
54
+
## VoltX.css
55
+
56
+
VoltX ships with an optional classless CSS framework inspired by Pico CSS and Tufte CSS. It provides beautiful, semantic styling for HTML elements without requiring any CSS classes—just write semantic markup and it looks great out of the box.
57
+
58
+
Features include typography with modular scale, Tufte-style sidenotes, styled form elements, dialogs, accordions, tooltips, tables, and more. See the framework's [README](../lib/README.md#voltxcss) for installation and usage details.
0 commit comments