From ff3a5e7ce450f1007ae39a47f4e1b431da04a23d Mon Sep 17 00:00:00 2001
From: Hayleigh Thompson <me@hayleigh.dev>
Date: Fri, 22 Dec 2023 01:37:39 +0000
Subject: :recycle: Refactor example apps to use lustre/try instead of vite.

---
 examples/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 examples/README.md

(limited to 'examples/README.md')

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.
-- 
cgit v1.2.3