From f982bf9e74a4d106711684548ae928f2b74ab596 Mon Sep 17 00:00:00 2001 From: Matthew Turney Date: Fri, 19 May 2017 14:41:52 -0500 Subject: [PATCH] add a readme explaining the purpose and source of this plugin --- plugins/git-escape-magic/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 plugins/git-escape-magic/README.md diff --git a/plugins/git-escape-magic/README.md b/plugins/git-escape-magic/README.md new file mode 100644 index 00000000..a14364f2 --- /dev/null +++ b/plugins/git-escape-magic/README.md @@ -0,0 +1,17 @@ +# Git Escape Magic + +This plugin is copied from the original at +https://github.com/knu/zsh-git-escape-magic. All credit for the +functionality enabled by this plugin should go to @knu. + +An excerpt from that project's readme explains it's purpose. + +> It eliminates the need for manually escaping those meta-characters. The zle function it provides is context aware and recognizes the characteristics of each subcommand of git. Every time you type one of these meta-characters on a git command line, it automatically escapes the meta-character with a backslash as necessary and as appropriate. + +## Useage + +To use this plugin add it to your list of plugins in your `.zshrc` file. + +**NOTE**: If you use url-quote-magic it must be included before this +plugin runs to prevent any conflicts. +