aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a44f676
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# vis-inotify - watch files using inotifywait
+
+## Example
+
+I use this plugin to dynamically reload my vis theme if it has changed.
+
+```lua
+local theme = "theme"
+local inotify = require('plugins/vis-inotify')
+inotify.add_recreate_watch('/home/muhq/.config/vis/themes/theme.lua', function(msg)
+ vis:command("set theme " .. theme) -- reload vis theme
+end, '-P')