first steps towards docs, (improved) todo, add key_release skeleton

1 files changed, 14 insertions, 0 deletions

diff --git a/README b/README
index d696733..2f939fa 100644
--- a/README
+++ b/README
@@ -410,6 +410,20 @@ This way, everything is kept private. It also turns Uzbl into a local variable,
 
 Copying the Uzbl object and creating public functions should be taken with care to avoid creating security holes. Keep in mind that the "f" function above would be defined in the `window` object, and as such any javascript in the current page can call it.
 
+### EVENTS ###
+
+unlike commands, events are not handled in uzbl itself, but are propagated asynchronously through text stream on
+stdout.  You'll usually use uzbl by piping it's output to a so called 'dispatcher'
+- makes it possible to use whichever language you want for event handling (python, perl, bash, .. you name it).
+  you'll usually send commands (see above) back to uzbl through its fifo or socket
+- keybindings use x keysyms
+- many finegrained events (hover_over_link, key_press, key_down,..)
+- see example dispatcher.sh
+
+Note: cookie events are not sent to a dispatcher but handled internally through the cookie handler because of their synchronous nature.
+Cookie events are really something completely different from all other events.  maybe someday we'll use http proxies or something for cookies, but
+for now we still use the handler code)
+
 ### COMMAND LINE ARGUMENTS
     uzbl [ uri ]
     -u, --uri=URI            Uri to load at startup (equivalent to 'uzbl <uri>' or 'set uri = URI' after uzbl has launched)