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
{{ message }}
Repository navigation
Commit 47c75df
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+48-14Lines changed: 48 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,8 @@ A small language for reactive UIs that carries
5
5
*language* semantics, and checks them before your code runs. Files are `.rx`;
6
6
they compile to plain Solid 2.0.
7
7
8
-
> **Status:**early design work. The spec, its scenarios and the reference
9
-
> implementation change often, and nothing here is released. See
8
+
> **Status:**experimental, 0.1. The spec, its scenarios and the compiler
9
+
> still change often, and releases follow Solid 2.0's release candidates. See
10
10
> [CONTRIBUTING.md](CONTRIBUTING.md) to run the suite or propose a change.
11
11
12
12
## Why
@@ -107,13 +107,49 @@ TSX projection ([spec/13](spec/13-types.md)). For whole apps, start with
107
107
|[`tooling/rx-language-server`](tooling/rx-language-server)| the `.rx` language server: TypeScript's hover, go to definition, rename, completion and type errors on `.rx`, plus the checker's diagnostics with their rules |
108
108
|[`tooling/vscode-rx`](tooling/vscode-rx)| the VS Code extension: highlighting, and the language server |
109
109
110
-
Nothing is published yet. `@reactivescript/compiler`,
111
-
`@reactivescript/runtime` and `@reactivescript/language-server` will go to
112
-
npm, and the extension to the VS Marketplace and Open VSX
113
-
([`tooling/RELEASING.md`](tooling/RELEASING.md)). In Vite, the compiler is a
114
-
front end that Solid's Vite plugin loads on its own when the package is
115
-
installed; that support is merged in Solid's plugin but not yet released
116
-
([`compiler/README.md`](compiler/README.md)).
110
+
## Install
111
+
112
+
ReactiveScript 0.1 is experimental. It follows Solid 2.0's release
113
+
candidates, so expect breaking changes until Solid 2.0 is final.
114
+
115
+
**In a Solid app (Vite).** Install the compiler and the runtime beside Solid
116
+
2.0:
117
+
118
+
```sh
119
+
npm i solid-js@next @solidjs/web@next @solidjs/signals@next @reactivescript/runtime
120
+
npm i -D vite @solidjs/vite-plugin @reactivescript/compiler
121
+
```
122
+
123
+
Keep `solid()` in `vite.config.js` as it is. Solid's Vite plugin
124
+
(3.0.0-next.57 or later) finds the compiler and compiles `.rx` on its own
0 commit comments