From 832fea13c105f21427235ddc02a7e1784c1ff00a Mon Sep 17 00:00:00 2001
From: Mohammed Goder <mg@noreply.git.mgoder.com>
Date: Thu, 14 Mar 2024 15:37:23 -0500
Subject: [PATCH] Add README.md

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5765dc
--- /dev/null
+++ 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
+       ```
\ No newline at end of file