diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 28 |
1 files changed, 27 insertions, 1 deletions
@@ -2,6 +2,31 @@ > A playground for building create web apps – powered by Gleam! +[](https://hex.pm/packages/lustre) +[](https://hexdocs.pm/lustre/) + +> ❗️ This package relies on Gleam's JavaScript FFI and will not work if your are +> targeting Erlang. + +--- + +## Installation + +If available on Hex, this package can be added to your Gleam project: + +```sh +gleam add lustre +``` + +and its documentation can be found at <https://hexdocs.pm/eval>. You will also +need to install `react` and `react-dom` from npm: + +```sh +npm i react react-dom +``` + +--- + ## Development First, make sure you have both Gleam and Node.js installed, then: @@ -12,4 +37,5 @@ npm start ``` This sets up `chokidar` to watch our gleam source code and runs the compiler -whenever we make a change. +whenever we make a change. It also starts a server that will serve the examples +located in `test/examples/`. |