Edit read.md

Modules/ConfigLoader.qml

@@ -8,6 +8,7 @@ Singleton {
 	id: root
 
 	property alias gifFolder: adapter.gifFolder
+	property alias maxScaling: adapter.maxScaling
 	property string configDir: Quickshell.env("HOME") + "/.config/I-DeskPet"
 	property string configPath: configDir + "/config.json"
 
@@ -48,6 +49,7 @@ Singleton {
 			id: adapter
 
             property string gifFolder: Quickshell.shellDir + "/Gifs"
+			property real maxScaling: 1
 		}
 	}
 }

Modules/GifsLoader.qml

@@ -38,7 +38,7 @@ Repeater {
 		Mouse {
 			id: mouse
 			onWheel: (wheel)=> {
-				gifSaved.scaling = Math.max( 1, ( gifSaved.scaling + 0.1 * ( wheel.angleDelta.y / 120 ) ) )
+				gifSaved.scaling = Math.max( ConfigLoader.maxScaling, ( gifSaved.scaling + 0.1 * ( wheel.angleDelta.y / 120 ) ) )
 			}
 			
 			onDoubleClicked: gifSaved.scaling = 1

README.md

@@ -7,10 +7,57 @@
 ## Feature list
 
 - [x] Hyprland keybind support
-  - [x] Swap Overlay <> Bottom
+  - [x] Toggle layer ontop/bottom
-  - [x] Swap Mouse area targetted -/+
+  - [x] Toggle active mouse area
-- [x] Dynamic pets
+- [x] Dynamic path + live update
-- [x] Multiple pets
+- [x] Supports multiple gifs
-- [x] Config location ~/.config/I-DeskPet/config.json
+- [x] User config options
-      {"gifFolder": "PATH"}
 - [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