summaryrefslogtreecommitdiff
path: root/plugins/fancy-ctrl-z/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/fancy-ctrl-z/README.md')
-rw-r--r--plugins/fancy-ctrl-z/README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/plugins/fancy-ctrl-z/README.md b/plugins/fancy-ctrl-z/README.md
index f1b1dfa5c..7766c51eb 100644
--- a/plugins/fancy-ctrl-z/README.md
+++ b/plugins/fancy-ctrl-z/README.md
@@ -1,14 +1,24 @@
-# Use Ctrl-Z to switch back to Vim
+# fancy-ctrl-z
-I frequently need to execute random commands in my shell. To achieve it I pause
+Allows pressing Ctrl-Z again to switch back to a background job.
+
+To use it, add `fancy-ctrl-z` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... fancy-ctrl-z)
+```
+
+## Motivation
+
+I frequently need to execute random commands in my shell. To achieve it I pause
Vim by pressing Ctrl-z, type command and press fg<Enter> to switch back to Vim.
-The fg part really hurts me. I just wanted to hit Ctrl-z once again to get back
-to Vim. I could not find a solution, so I developed one on my own that
+The fg part really hurts me. I just wanted to hit Ctrl-z once again to get back
+to Vim. I could not find a solution, so I developed one on my own that
works wonderfully with ZSH.
Source: http://sheerun.net/2014/03/21/how-to-boost-your-vim-productivity/
-Credits:
+Credits:
- original idea by @sheerun
- added to OMZ by @mbologna