summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 352f460..c1cd21a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-i3lock - improved screen locker
+i3lock-img - improved screen locker fork with increased custom image capabilities
===============================
i3lock is a simple screen locker like slock. After starting it, you will
see a white screen (you can configure the color/an image). You can return
to your screen by entering your password.
+i3lock-img
+- adds the ability to specify -k to display certain images based on
+ number of characters entered
+
+- adds the ability to specify -a to display certain images at various
+ authorization states instead of the old ugly circle
+
+example :
+ ./i3lock -a ./auth -k ./keypress -K 50
+ - will display ./auth/0.png on idle, ./auth/1.png of verify, ./auth/3.png on wrong password
+ - will display ./keypress/$x.png based on how man characters, $x of the password have been entered
+
Many little improvements have been made to i3lock over time:
- i3lock forks, so you can combine it with an alias to suspend to RAM