aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2018-12-29 22:03:42 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-12-29 22:03:42 +1300
commit57608dd23b6be224c74a03f2d27112b9b08f4816 (patch)
tree8774a13e7d4c1da613fd4a70c2840f52c5aa609a /README.md
downloadvim-regex-escape-57608dd23b6be224c74a03f2d27112b9b08f4816.tar.gz
vim-regex-escape-57608dd23b6be224c74a03f2d27112b9b08f4816.zip
First versionv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b779fc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+regex\_escape.vim
+=================
+
+This plugin provides normal and visual mode mapping targets to insert escaping
+backslash characters before regular expression metacharacters for text selected
+by a motion, as a quick way to put a literal string into a regular expression
+context.
+
+It's useful generally as a shortcut, but the author particularly likes it for
+keeping track of backslash-heavy expressions where counting gets tiresome.
+
+For example, in the default BRE mode, this string:
+
+ foo * ^bar $\ baz \ quux
+
+Becomes:
+
+ foo \* \^bar \$\\ baz \\ quux
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+
+[1]: https://sanctum.geek.nz/