Edit read.md

README.md

@@ -7,10 +7,57 @@
 ## Feature list
 
 - [x] Hyprland keybind support
-  - [x] Swap Overlay <> Bottom
-  - [x] Swap Mouse area targetted -/+
-- [x] Dynamic pets
-- [x] Multiple pets
-- [x] Config location ~/.config/I-DeskPet/config.json
-      {"gifFolder": "PATH"}
+  - [x] Toggle layer ontop/bottom
+  - [x] Toggle active mouse area
+- [x] Dynamic path + live update
+- [x] Supports multiple gifs
+- [x] User config options
 - [x] Evernight base gif img
+
+# Config
+
+Configuration is found at:
+
+```zsh
+~/.config/I-DeskPet
+```
+
+Options:
+
+- gifFolder
+- maxScaling
+
+Example for config.json:
+
+```json
+{
+  "gifFolder": "/home/inorishio/Pictures/Pets",
+  "maxScaling": 1
+}
+```
+
+# Hyprland keybinds
+
+Toggle click through
+
+```zsh
+bind = CTRL, mouse:274, global, I-DeskPet:toggle-Region
+```
+
+Toggle between having your gif on your background vs foreground
+
+```zsh
+bind = SHIFT, mouse:274, global, I-DeskPet:toggle-Layer
+```
+
+Keybind for cycling through gif layering.
+Hover over which gif you want to cycle it's layer for and use the keybind.
+
+```zsh
+bind = $mainMod, Z, global, I-DeskPet:cycle-zIndex
+```
+
+# Other keybinds
+
+Double click = Reset gif size to original
+Scroll = Scales the gif up and or down