aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndy Thompson <andrew.thompson@qmul.ac.uk>2022-02-11 01:00:55 +0000
committerAndy Thompson <andrew.thompson@qmul.ac.uk>2022-02-11 01:00:55 +0000
commit72f64a5192da97307156c1529838556f15e94ffa (patch)
tree422c7e10dbab6ed9f52498971c111c0c2420dce6 /README.md
downloadlustre-72f64a5192da97307156c1529838556f15e94ffa.tar.gz
lustre-72f64a5192da97307156c1529838556f15e94ffa.zip
:tada: Init repo.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d9e5f5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# gleam_lustre
+
+A Gleam project
+
+## Quick start
+
+```sh
+gleam run # Run the project
+gleam test # Run the tests
+gleam shell # Run an Erlang shell
+```
+
+## Installation
+
+If available on Hex this package can be added to your Gleam project.
+
+```sh
+gleam add gleam_lustre
+```