aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHayleigh Thompson <me@hayleigh.dev>2024-02-21 20:56:56 +0000
committerHayleigh Thompson <me@hayleigh.dev>2024-02-21 20:56:56 +0000
commit0fc9a27e2cf1828fc4235f2a03d5bd5ecc303606 (patch)
tree2c7dc5073c34fe94dda250bf59b1b3e8e00cc3e9
parent8522882f2fc96330069ee52d196db85345aefd99 (diff)
downloadlustre-0fc9a27e2cf1828fc4235f2a03d5bd5ecc303606.tar.gz
lustre-0fc9a27e2cf1828fc4235f2a03d5bd5ecc303606.zip
:pencil: Fix typos and minor improvements.
-rw-r--r--docs/guide/01-quickstart.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/guide/01-quickstart.md b/docs/guide/01-quickstart.md
index 08cd4c0..6e8b13d 100644
--- a/docs/guide/01-quickstart.md
+++ b/docs/guide/01-quickstart.md
@@ -36,19 +36,19 @@ runtime. Some of Lustre's core features include:
To get started, let's create a new Gleam application and add Lustre as a dependency.
```sh
-$ gleam new app && gleam add lustre
+$ gleam new app && cd app && gleam add lustre
```
By default, Gleam builds projects for the Erlang target unless told otherwise. We
can change this by adding a `target` field to the `gleam.toml` file generated in
the root of the project.
-```toml
-name = "app"
-target = "javascript"
-version = "1.0.0"
+```diff
+ name = "app"
++ target = "javascript"
+ version = "1.0.0"
-...
+ ...
```
The simplest type of Lustre application is constructed with the `element` function.
@@ -216,7 +216,7 @@ world – whether that's fetching data from an API, setting up a WebSocket conne
or even just setting a timer.
Lustre manages these side effects through an abstraction called an `Effect`. In
-essense, effects are any functions that talk with the outside world and might
+essence, effects are any functions that talk with the outside world and might
want to send messages back to your application. Lustre lets you write your own
effects, but for now we'll use a community package called
[`lustre_http`](https://hexdocs.pm/lustre_http/index.html) to fetch a new cat image