summaryrefslogtreecommitdiff
path: root/plugins/fancy-ctrl-z
diff options
context:
space:
mode:
authorMarc Cornellà <marc@mcornella.com>2024-08-09 09:44:46 +0200
committerMarc Cornellà <marc@mcornella.com>2024-08-09 09:44:46 +0200
commitefafef8495f030501e0df59ccb76a598bbce3ae1 (patch)
tree561eaba6adf7cd198d0b8d5b3c07dcd724572b72 /plugins/fancy-ctrl-z
parentfccaaf2fc60149baab966acaeae35f55325e6f98 (diff)
downloadzsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.gz
zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.bz2
zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.zip
docs: improve several plugin READMEs and add one for `ssh` plugin
Diffstat (limited to 'plugins/fancy-ctrl-z')
-rw-r--r--plugins/fancy-ctrl-z/README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/plugins/fancy-ctrl-z/README.md b/plugins/fancy-ctrl-z/README.md
index 82a4fd75e..7766c51eb 100644
--- a/plugins/fancy-ctrl-z/README.md
+++ b/plugins/fancy-ctrl-z/README.md
@@ -1,4 +1,14 @@
-# Use Ctrl-Z to switch back to Vim
+# fancy-ctrl-z
+
+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.