path: root/README.md
diff options
Diffstat (limited to 'README.md')
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 @@
+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
+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
+ foo \* \^bar \$\\ baz \\ quux
+Copyright (c) [Tom Ryder][1]. Distributed under the same terms as Vim itself.
+See `:help license`.
+[1]: https://sanctum.geek.nz/