aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.md b/README.md
index cd5ac20..4494892 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,7 @@
# vis-cursors
-Remembering cursor positions in the [vis editor](https://github.com/martanne/vis).
+Remember cursor position per file, for the [vis editor](https://github.com/martanne/vis).
-# How to
-1. `ln -s cursors.lua .config/vis/plugins`
-2. `require('plugins/cursors')` in `visrc.lua`
+# Usage
+Load `cursors.lua` in your `visrc.lua` file ( see [Plugins](https://github.com/martanne/vis/wiki/Plugins) ).
-`module.cursors_path` defaults to `~/.cursors`, and store your cursor positions. You can overwrite this variable.
+Cursor positions are stored in `$HOME/.cursors`, or you can set the `module.path` variable.