aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAndreas2023-11-14 12:26:24 +0100
committerAndreas2023-11-14 12:26:24 +0100
commit98a5de707a4f3f49459211e5d903ae597ea7fbe5 (patch)
treeaeec1ecf36a4a15791ddcbe1a4d9dfb3c2d5a316 /README.md
downloadaur-nicelock.tar.gz
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..c30cd6436582
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# nicelock
+
+Shell script for making i3lock look nice.
+
+Run with `nicelock`.
+
+## Notifications
+
+`nicelock` will automatically suspend dunst notifications and show a notification when locking.
+
+## Automatic locking
+
+Example using `xss-lock`
+
+```sh
+xss-lock -- /usr/bin/nicelock
+```
+
+Place this is your `.xinitrc` or spawn it in your window manager like this in `xmonad`:
+
+```hs
+myStartupHook = do
+ ...
+ spawnOnce "xss-lock -- /usr/bin/nicelock"
+ ...
+ defaults = def {
+ ...
+ startupHook = myStartupHook
+ }
+```