Support for keyword based syntax highlighting (much faster)

See the following issues on GitHub:
 - https://github.com/xolox/vim-easytags/issues/68
 - https://github.com/xolox/vim-easytags/pull/80

Please note that right now this 'feature' is not integrated with
the "accelerated Python syntax highlighting" feature, because I'm
considering ripping that out and replacing it with a *fast* Vim
script implementation (if I can build one :-).

1 files changed, 12 insertions, 0 deletions

diff --git a/README.md b/README.md
index ae6aedf..5b4640a 100644
--- a/README.md
+++ b/README.md
@@ -72,6 +72,18 @@ By setting this option to true (1) you enable asynchronous tags file updates. Go
 
 Note that asynchronous updates on Windows currently require the installation of my [vim-shell] [shell] plug-in (for obscure technical reasons that I want to fix but don't know how yet).
 
+### The `g:easytags_syntax_keyword` option
+
+When you look into how the dynamic syntax highlighting in the vim-easytags plug-in works you'll realize that vim-easytags is really abusing Vim's syntax highlighting engine. This can cause Vim to slow down to a crawl, depending on how big your tags files are. To make things worse in Vim 7.4 a new regex engine was introduced which exacerbates the problem (the patterns generated by vim-easytags bring out the worst of the new regex engine).
+
+Since version 3.6 the vim-easytags plug-in tries to squeeze as much performance as possible out of Vim by using keyword highlighting where this is possible without sacrificing accuracy. If your Vim's syntax highlighting is still too slow you can add the following to your [vimrc script] [vimrc]:
+
+    let g:easytags_syntax_keyword = 'always'
+
+The default value of this option is 'auto' which means to use keyword highlighting where this is possible without sacrificing accuracy. By changing it to 'always' you're telling vim-easytags to sacrifice accuracy in order to gain performance. Try it out and see what works best for you.
+
+Please note that right now this 'feature' is not integrated with the "accelerated Python syntax highlighting" feature, because I'm considering ripping that out and replacing it with a *fast* Vim script implementation.
+
 ### The `g:easytags_languages` option
 
 Exuberant Ctags supports many languages and can be extended via regular expression patterns, but for some languages separate tools with ctags-compatible output exist (e.g. [jsctags] [jsctags] for Javascript). To use these, the executable and its arguments must be configured: