From 03030ea62b59e859e068aa76eb1692dd1ef807f7 Mon Sep 17 00:00:00 2001
From: Filip Figiel <figiel.filip@gmail.com>
Date: Mon, 23 May 2022 20:36:17 +0200
Subject: =?UTF-8?q?=F0=9F=94=80=F0=9F=93=9D=20add=20a=20fully-fledged=20ex?=
 =?UTF-8?q?ample=20project=20(#2)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* docs: add a full-fledged example project

* fix: use correct script path

* docs: improve example readme commands

* chore: ignore the dist folder

* chore: cleanup the makefile
---
 example/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 example/README.md

(limited to 'example/README.md')

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..014e017
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,21 @@
+# lustre_counter
+
+This is an example Lustre project. It uses [watchexec](https://github.com/watchexec/watchexec) to rebuild the Gleam project on save.
+
+## Quick start
+
+Initial setup:
+```sh
+npm install
+gleam build
+```
+
+Run dev server on `localhost:3000`:
+```sh
+make dev
+```
+
+Make a production build under `dist` folder:
+```sh
+make
+```
-- 
cgit v1.2.3