From 771e600b4fcc6a3fbfe8870e73b7c2082b5413d2 Mon Sep 17 00:00:00 2001
From: BanceDev
Date: Mon, 23 Feb 2026 20:19:30 -0500
Subject: add instructions to readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5743b48..539e6f3 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
 # lockrs
 
 A minimal X11 lockscreen make with xcb and rust.
+
+## Installation
+
+Clone the repo and then run:
+
+```
+cargo install --path .
+```
+
+ensure that `~/.cargo/bin` is on your PATH to be able to launch the application.
+
+## Usage
+
+You can run it from the command line or a launcher with `lockrs` or you could setup an auto lockscreen functionality like this `xautolock -time 5 -locker lockrs`. Note: xautolock is external software that you would need to download.
-- 
cgit v1.2.3-59-g8ed1b