aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2023-08-19 22:21:19 +0100
committerHayleigh Thompson <me@hayleigh.dev>2023-08-19 22:21:19 +0100
commit9919bc2702c89168d1805eaa0db9e4baff091260 (patch)
treeef5f1fd360d90ec8433aa0fccc2709bed0e8e9d2 /README.md
parente4aa0e04e54105395d5f6f5e3f7e2d9a4f7851e0 (diff)
downloadlustre-9919bc2702c89168d1805eaa0db9e4baff091260.tar.gz
lustre-9919bc2702c89168d1805eaa0db9e4baff091260.zip
:truck: Shift things around to accomodate a monorepo.
Diffstat (limited to 'README.md')
-rw-r--r--README.md66
1 files changed, 0 insertions, 66 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index b6d111c..0000000
--- a/README.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# Lustre
-
-An Elm-inspired framework for building web apps in 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/)
-
-```gleam
-import gleam/int
-import lustre
-import lustre/element.{button, div, p, text}
-import lustre/event.{on_click}
-import lustre/cmd
-
-pub fn main() {
- let app = lustre.simple(init, update, render)
- let assert Ok(_) = lustre.start(app, "#app")
-
- Nil
-}
-
-fn init() {
- 0
-}
-
-type Msg {
- Incr
- Decr
-}
-
-fn update(state, msg) {
- case msg {
- Incr -> state + 1
- Decr -> state - 1
- }
-}
-
-fn render(state) {
- div(
- [],
- [
- button([on_click(Decr)], [text("-")]),
- p([], [text(int.to_string(state))]),
- button([on_click(Incr)], [text("+")]),
- ],
- )
-}
-```
-
----
-
-❗️ This package relies on Gleam's JavaScript FFI and is intended to be run in
-the browser. **It will not work if your are targetting Node.js or Erlang.**
-
----
-
-## Installation
-
-Lustre is available on [Hex](https://hex.pm/packages/lustre). You can install
-it like any other Hex package:
-
-```sh
-$ gleam add lustre
-```