aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2022-03-20 10:58:23 +0000
committerHayleigh Thompson <me@hayleigh.dev>2022-03-20 10:58:23 +0000
commit170a249f1bc5caae55ae5a3469f0fc6beef63568 (patch)
tree13a65659aa2aef065d1acf59af20a109df83eaa4 /README.md
parent06e3827589771da31bf033d304da4ba3a40c9cde (diff)
downloadlustre-170a249f1bc5caae55ae5a3469f0fc6beef63568.tar.gz
lustre-170a249f1bc5caae55ae5a3469f0fc6beef63568.zip
:construction: Morphdom is dead, long live React.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 10 insertions, 14 deletions
diff --git a/README.md b/README.md
index 8d9e5f5..d339fd1 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,15 @@
-# gleam_lustre
+# Lustre
-A Gleam project
+> A playground for building create web apps – powered by Gleam!
-## Quick start
+## Development
-```sh
-gleam run # Run the project
-gleam test # Run the tests
-gleam shell # Run an Erlang shell
-```
-
-## Installation
+First, make sure you have both Gleam and Node.js installed, then:
-If available on Hex this package can be added to your Gleam project.
-
-```sh
-gleam add gleam_lustre
+```bash
+npm i
+npm start
```
+
+This sets up `chokidar` to watch our gleam source code and runs the compiler
+whenever we make a change.