Update README with new docs and info on the fork0.1

1 files changed, 34 insertions, 22 deletions

diff --git a/README.md b/README.md
index 1c0f1f7..258789d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 *lead* provides hot-corners for your desktop, notably for openbox, awesome, i3 and other window managers.
 
+This fork adds support for specifying an interval to wait before the action is triggered. There may be more improvements in the future.
+
 ![Screenshot of lead](https://github.com/mlde/lead/blob/master/screenshot.png)
 > Despite the screenshot, the sensors are only 1px in size and invisible.
 
@@ -33,10 +35,6 @@ To build *lead* open a terminal in the root folder of the repository and:
 - Qt5Gui 
 - Qt5Core
 
-### Build
-
-A build `lead` is provided in `data/usr/bin/`. It was build on my arch64 system.
-
 
 # Install it
 
@@ -55,28 +53,32 @@ On the first run lead will look into these dirs for a conf-file. The first one f
 If none of these exists, it will create `~/.config/lead/lead.conf` with default values for each screen, ie:
 
     [eDP1]
-    bottom=
-    bottomLeft=
-    bottomRight=
-    left=
-    right=
-    top=
-    topLeft=
-    topRight=
+    bottom-action=
+    bottom-interval=0
+    bottomLeft-action=
+    bottomLeft-interval=0
+    bottomRight-action=
+    bottomRight-interval=0
+    left-action=
+    left-interval=0
+    right-action=
+    right-interval=0
+    top-action=
+    top-interval=0
+    topLeft-action=
+    topLeft-interval=0
+    topRight-action=
+    topRight-interval=0
 
 To enable a action for a sensor, simply add a command to the corner or side:
 
-    [eDP1]
-    bottom=
-    bottomLeft=chromium
-    bottomRight=thunar
-    left=
-    right=
-    top=
-    topLeft=californium toggle
-    topRight=skippy-xd
+    bottomLeft-action=chromium
+
+The intervals are set in milliseconds. For example, to set chromium to open only after the mouse has been in the corner for 1 second, do:
+
+    bottomLeft-interval=1000
 
-Used config-files and theme-files are monitored and changes are applied automatically.
+The configuration file is monitored and changes are applied automatically.
 
 
 # Use it
@@ -96,3 +98,13 @@ To uninstall *lead* open a terminal in the root folder of the repository and:
 # Drawbacks
 
 I didnt want to poll the mouse, so i created sensors which works with events. The sensors are transparent, but need a running compositor like compton for that. Without a compositor, they are black.
+
+# TODO
+
+Improvements that need to be made:
+
+- Error checking of the conf file; e.g. check that an integer was set for the interval
+
+Possible new features:
+
+- Custom regions