add instructions to readme

1 files changed, 14 insertions, 0 deletions

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.