added support for all event except INIT, START, QUIT

1 files changed, 46 insertions, 3 deletions

diff --git a/README.md b/README.md
index c6f4123..98ba0e0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-## vis-filetype-settings
+## vis-filetype-settings (move-events branch)
 
 This plugin provides a declarative interface for setting vis
 options depending on filetype.
@@ -25,8 +25,51 @@ settings = {
 }
 ```
 
-Be sure not to run commands that open another window with the same
-filetype, leading to an infinite loop.
+### More events
+
+By default, all settings are run on the WIN_OPEN event, but if you
+want, you can specify your own event.
+
+For more information about these events, check out the [documentation
+for the Lua API][doc].  Below is a description of which events are
+supported by this plugin.
+
+[doc]: http://martanne.github.io/vis/doc/index.html#events
+
+#### File events
+
+- FILE_OPEN
+- FILE_CLOSE
+- FILE_SAVE_POST
+- FILE_SAVE_PRE
+
+```lua
+settings = {
+    go = {"set et off", "set tw 8", FILE_SAVE_PRE = "gofmt"}
+}
+```
+
+This will execute the vis command `gofmt` when Go files are saved.
+
+**WARNING: The command will run in the current window, regardless
+of whether it contains a Go file**.
+
+### Window events
+
+- WIN_CLOSE
+- WIN_HIGHLIGHT
+- WIN_OPEN
+- WIN_STATUS
+
+WIN_OPEN is the default event.
+
+### Other events
+
+- INPUT
+
+**WARNING: If you run a vis command on INPUT, vis will automatically
+return to normal mode.**  There is currently no workaround, as far
+as I am aware.
 
 ### Installation