aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index 321f4b7..6e04cdc 100644
--- a/README.md
+++ b/README.md
@@ -74,3 +74,28 @@ import in `visrc.lua`:
require('editorconfig/edconf')
vis:command('set edconfhooks on') -- supposing you did previously
-- require('vis')
+
+### Setting arbitrary options
+
+To some it might be convenient to use editorconfig files to set arbitrary
+vis options. Therefore, the vis editorconfig plugin uses the `vis_`
+prefix in keys as an interface to anything that can be specified with
+`:set`.
+
+Instead of running `:set spelllang en_US` after opening a file, for
+instance, one can also add
+
+ vis_spelllang = en_US
+
+to the appropriate section of an editorconfig file.
+
+Note that keys in editorconfig are case-insensitive. The specification
+suggests to lowercase them. Therefore, it is only possible to use this
+mechanism for lowercase options. If you really need to use upper or
+camel case options, add an alias to your `visrc.lua`:
+
+```lua
+vis:option_register("snake_case_option", "string", function(value)
+ vis:command("set camelCaseOption " .. value)
+end, "Alias for camelCaseOption")
+```