Diff
1diff --git a/README.md b/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..5786f1a82cfbd8316adb9c1693528e260e582247
4--- /dev/null
5+++ b/README.md
6@@ -0,0 +1,66 @@
7+# hy3
8+i3 / sway like layout for [hyprland](https://github.com/hyprwm/hyprland).
9+
10+### Features
11+- [x] i3 like tiling
12+- [x] Window splits
13+- [x] Window movement
14+- [x] Window resizing
15+- [ ] Selecting a group of windows at once (and related movement)
16+- [ ] Tabbed groups
17+- [ ] Some convenience dispatchers not found in i3 or sway
18+
19+### Stability
20+As of now hy3 is stable enough to use normally as long as you don't change layout after loading the plugin (currently unimplemented).
21+If you encounter any crashes or bugs please report them in the issue tracker.
22+
23+When reporting bugs, please include:
24+- Commit hash of the version you are running.
25+- Steps to reproduce (if you can figure them out)
26+- backtrace of the crash
27+
28+If you don't know how to reproduce it or can't, or you can't take a backtrace please still report the issue.
29+
30+## Configuration
31+hy3 requires using a few custom dispatchers for normal operation.
32+In your hyprland config replace the following dispatchers:
33+ - `movefocus` -> `hy3:movefocus`
34+ - `movewindow` -> `hy3:movewindow`
35+
36+You can use `hy3:makegroup` to create a new split.
37+
38+### Dispatcher list
39+ - `hy3:makegroup, <h | v>` - make a vertical or horizontal split
40+ - `hy3:movefocus, <l | u | d | r>` - move the focus left, up, down, or right
41+ - `hy3:movewindow, <l | u | d | r>` - move a window left, up, down, or right
42+ - `hy3:debugnodes` - print the node tree into the hyprland log
43+
44+## Installing
45+
46+### Nix
47+Under nix, use the provided devShell, then go to [Manual Installation](#manual)
48+
49+### [Hyprload](https://github.com/Duckonaut/hyprload) (currently untested)
50+Add an entry to your hyprload.toml like so:
51+
52+```toml
53+plugins = [
54+ # ...
55+ "outfoxxed/hy3"
56+ # ...
57+]
58+```
59+
60+### Manual
61+First export `HYPRLAND_HEADERS`, then run the following commands:
62+
63+```sh
64+mkdir build
65+cd build
66+cmake -DCMAKE_BUILD_TYPE=Debug ..
67+make
68+```
69+
70+> **Note**: Please use a debug build as debugging a backtrace from a release build is much more difficult if you need to report an error.
71+
72+The plugin will be located at `build/libhy3.so`.