Merge pull request pangloss#131 from pangloss/hotfix/regex-note

goatslacker · goatslacker · commit ae0ab52799ad · 2013-08-24T11:17:19.000-07:00
README note on regexes
diff --git a/README.md b/README.md
@@ -2,6 +2,24 @@
 
 JavaScript bundle for vim, this bundle provides syntax and indent plugins.
 
+## A Quick Note on Regexes
+
+Vim 7.4 was released recently, and unfortunately broke how this plugin
+handles regexes. There was no real easy way for us to fix this unless we
+completely rewrote how regexes work.
+
+Good News: There was a recent update to Vim 7.4 that fixes this issue.
+
+Make sure you are at least using Vim 7.4, with patches 1-7.
+
+If you are stuck on an older version of Vim 7.4 with no way to update,
+then simply perform the following commands to fix your current buffer:
+
+```
+:set regexpengine=1
+:syntax enable
+```
+
 ## Installation
 
 - Install with [Vundle](https://github.com/gmarik/vundle)
@@ -51,13 +69,13 @@ Default Value: 0
 
 ## Contributing
 
-This project uses the [git 
-flow](http://nvie.com/posts/a-successful-git-branching-model/) model for 
-development. There's [a handy git module for git 
-flow](//github.com/nvie/gitflow). If you'd like to be added as a contributor, 
-the price of admission is 1 pull request. Please follow the general code style 
-guides (read the code) and in your pull request explain the reason for the 
-proposed change and how it is valuable. 
+This project uses the [git
+flow](http://nvie.com/posts/a-successful-git-branching-model/) model for
+development. There's [a handy git module for git
+flow](//github.com/nvie/gitflow). If you'd like to be added as a contributor,
+the price of admission is 1 pull request. Please follow the general code style
+guides (read the code) and in your pull request explain the reason for the
+proposed change and how it is valuable.
 
 ## Bug report
 
