aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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.