initial commit

1 files changed, 16 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2e6523b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# vis-lockfiles - detect concurrent edits
+
+This is a simple `vis` plugin to detect if a file is concurrently edited by
+multiple vis processes.
+
+## Configuration
+
+By default, the lockfiles will be placed in `$XDG_RUNTIME_DIR/vis/locks/`.
+
+The `directory` member of the module table can be used to define the lock file
+location.
+
+```lua
+local lockfiles = require('plugins/vis-lockfiles')
+lockfiles.direcory = '$HOME'
+```