Diff
1diff --git a/README.md b/README.md
2index e04bf79774649ab862b3df182d5b257364059909..07941e9950a0ba9fb5741c97ae6dfb7457cd97c5 100644
3--- a/README.md
4+++ b/README.md
5@@ -19,12 +19,15 @@ Additional features may be suggested in the repo issues or the [matrix room](htt
6 <video width="640" height="360" controls="controls" src="https://user-images.githubusercontent.com/83010835/255322916-85ae8196-8b12-4e15-b060-9872db10839f.mp4"></video>
7
8 ### Stability
9-hy3 always tracks the latest (git) version of hyprland. It likely will not work when built against a given stable
10-hyprland release, however it will probably work within a few commits of the latest hyprland version. Please ping
11-`@outfoxxed:outfoxxed.me` in the [matrix room](https://matrix.to/#/#hy3-general:outfoxxed.me) or make an issue
12-if hy3 does not build or function against the latest hyprland commit.
13+hy3 has a tagged release for each hyprland update, and master tracks hyprland's main branch.
14+If you are running a release version of hyprland then use the matching tagged hy3 version.
15+If you are running an untagged hyprland release then use the `master` branch of hy3.
16
17-Commits are tested for obvious crashes before pushing and usually fine, however you may occasionally find a bug.
18+Commits are tested before pushing and will build against the hyprland release **in the flake.lock file**.
19+There may be a mismatch with hyprland's main branch. If hy3 fails to build against hyprland's main branch
20+please make an issue or ping me in the [hy3 matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me).
21+
22+Tagged hy3 versions are always checked against the corrosponding hyprland tag.
23
24 If you encounter any bugs, please report them in the issue tracker.
25
26@@ -37,6 +40,15 @@ If you are too lazy to use the issue tracker, please at least ping `@outfoxxed:o
27 in the [matrix room](https://matrix.to/#/#hy3-support:outfoxxed.me) with your bug information.
28
29 ## Installation
30+
31+> [!IMPORTANT]
32+> The master branch of hy3 follows the master branch of hyprland.
33+> Attempting to use a mismatched hyprland release will result in failure when building or loading hy3.
34+>
35+> To use hy3 against a release version of hyprland,
36+> check out the matching hy3 tag for the hyprland version.
37+> hy3 tags are formatted as `hl{version}` where `{version}` matches the release version of hyprland.
38+
39 ### Nix
40 #### Hyprland home manager module
41 Assuming you use hyprland's home manager module, you can easily integrate hy3 by adding it to the plugins array.
42@@ -54,9 +66,11 @@ Assuming you use hyprland's home manager module, you can easily integrate hy3 by
43 };
44
45 hyprland.url = "github:hyprwm/Hyprland";
46+ # or "github:hyprwm/Hyprland?ref=v{version}" for a release version of hyprland
47
48 hy3 = {
49 url = "github:outfoxxed/hy3";
50+ # or "github:outfoxxed/hy3?ref=hl{version}" for a release version of hyprland
51 inputs.hyprland.follows = "hyprland";
52 };
53 };
54@@ -112,6 +126,12 @@ The plugin will be located at `build/libhy3.so`, and you can load it normally
55 Note that the hyprland headers and pkg-config file **MUST be installed correctly, for the target version of hyprland**.
56
57 ## Configuration
58+
59+> [!IMPORTANT]
60+> The configuration listed below is for the current hy3 commit.
61+> If you are using a release version of hy3 then make sure you are
62+> reading the tagged revision of this readme.
63+
64 Set your `general:layout` to `hy3` in hyprland.conf.
65
66 hy3 requires using a few custom dispatchers for normal operation.