Add README.md

2024-03-14 15:37:23 -05:00 · 2024-03-14 15:37:23 -05:00 · 832fea13c1
commit 832fea13c1
parent be83449995
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,12 @@
+# Hyprlock
+Hyprlock is a script that allows for the mouse cursor to be locked to a monitor.
+
+Setup:
+  1. Copy `hyprlock.sh` into `~/.config/hypr`
+  2. Execute `chmox +x ~/.config/hypr/hyprlock.sh`
+  3. Add the following lines to `~/.config/hypr/hyprland.conf`.\
+     Example:
+       ```bash
+       env = PATH=$PATH:~/.config/hypr
+       bind = $mainMod, Q, exec, ~/.config/hypr/hyprlock.sh
+       ```