From 1016a9005cd2d034e07380f3877d29fa9c26a8fe Mon Sep 17 00:00:00 2001
From: Hayleigh Thompson <me@hayleigh.dev>
Date: Sat, 14 May 2022 10:32:22 +0100
Subject: :memo: Update README.

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index d339fd1..ae30c41 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,31 @@
 
 > A playground for building create web apps – powered by Gleam!
 
+[![Package Version](https://img.shields.io/hexpm/v/lustre)](https://hex.pm/packages/lustre)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/lustre/)
+
+> ❗️ This package relies on Gleam's JavaScript FFI and will not work if your are
+> targeting Erlang.
+
+---
+
+## Installation
+
+If available on Hex, this package can be added to your Gleam project:
+
+```sh
+gleam add lustre
+```
+
+and its documentation can be found at <https://hexdocs.pm/eval>. You will also
+need to install `react` and `react-dom` from npm:
+
+```sh
+npm i react react-dom
+```
+
+---
+
 ## Development
 
 First, make sure you have both Gleam and Node.js installed, then:
@@ -12,4 +37,5 @@ npm start
 ```
 
 This sets up `chokidar` to watch our gleam source code and runs the compiler
-whenever we make a change.
+whenever we make a change. It also starts a server that will serve the examples
+located in `test/examples/`.
-- 
cgit v1.2.3