From 0b88d6e0af46cc6c41e3d82dcb8be269ffa242f2 Mon Sep 17 00:00:00 2001 From: Austin Bingham Date: Tue, 16 May 2017 15:31:21 +0200 Subject: [PATCH] Updated README to reflect new "enabled" toggle. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 377aff5..ba0a1c3 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,14 @@ To use `flycheck-vale` just `require` it and run `flycheck-vale-setup`: (require 'flycheck-vale) (flycheck-vale-setup) ``` + +## Dis/enabling flycheck vale for specific buffers + +The buffer-local variable `flycheck-vale-enabled` allows you to enabled or +disable vale linting for specific buffers. If this variable is `t` then vale +linting will be performed (assuming you've got `flycheck-mode` enabled, etc.) +Likewise, if it is `nil` then vale linting will never be performed. + +You can use `flycheck-vale-toggle-enabled` to toggle this variable between `t` +and `nil`. (And of course you can set it other ways if you want.) By default the +variable is `t`.