aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2023-12-22 01:37:39 +0000
committerHayleigh Thompson <me@hayleigh.dev>2023-12-22 11:01:21 +0000
commitff3a5e7ce450f1007ae39a47f4e1b431da04a23d (patch)
treee355b8c8cbc5c662b8f700360672d43ae1dce519 /examples/README.md
parentec7b40fc801e5f5af372f7b0b6524ee0bfcf8d3c (diff)
downloadlustre-ff3a5e7ce450f1007ae39a47f4e1b431da04a23d.tar.gz
lustre-ff3a5e7ce450f1007ae39a47f4e1b431da04a23d.zip
:recycle: Refactor example apps to use lustre/try instead of vite.
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..2c601ea
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,26 @@
+# Lustre examples
+
+Each of these examples is a complete Gleam project that contains a Lustre app
+that demos or tests a particular feature of Lustre. To run any of them, navigate
+to the example's directory and first run:
+
+```sh
+$ gleam build
+```
+
+Then serve the app using `lustre/try`:
+
+```sh
+$ gleam run -m lustre/try
+```
+
+If you do not specify a target, this will attempt to serve the app using an Erlang
+HTTP server. If you'd prefer to serve using Node, you can specify the JavaScript
+target instead:
+
+```sh
+$ gleam run -m lustre/try --target javascript
+```
+
+Or you may additionally supply the `--runtime deno` flag to serve using Deno rather
+than Node.