From 1059d622e496d8a301c0ab9278a7ab13ac276a8e Mon Sep 17 00:00:00 2001
From: Hayleigh Thompson <me@hayleigh.dev>
Date: Tue, 12 Mar 2024 08:07:13 +0100
Subject: :memo: Update readme to point out rc status.

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 9b6afcf..82d58d3 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
     </a>
     <span> | </span>
     -->
-    <a href="https://hexdocs.pm/lustre/4.0.0-rc1/guide/01-quickstart.html">
+    <a href="https://hexdocs.pm/lustre/4.0.0-rc.2/guide/01-quickstart.html">
       Quickstart
     </a>
     <span> | </span>
@@ -146,6 +146,10 @@ your Gleam projects from the command line:
 $ gleam add lustre
 ```
 
+> **Note**: this guide is written for Lustre v4, which is currently in release
+> candidate status. To follow along with this guide, you need to _manually_ edit
+> your `gleam.toml` and change the required version of lustre to `"4.0.0-rc.2"`.
+
 If you're using a different build tool, like Rebar3 or Mix, you can add Lustre
 to your `rebar.config` or `mix.exs` file respectively.
 
-- 
cgit v1.2.3