summaryrefslogtreecommitdiff
path: root/plugins/magic-enter/Readme.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-10-21 16:01:02 -0600
committerTuowen Zhao <ztuowen@gmail.com>2019-10-21 16:01:02 -0600
commit2e9fe98b8a9fe21b982e719e129678dede63771e (patch)
treee1dd9634ace0de1c752bddcbc67a998b7d73d40b /plugins/magic-enter/Readme.md
parent112a85697481cae663ff281b74fdc1f72a67b294 (diff)
parent534ec60bfd14ee640076c7594ee4fa723fafd1b1 (diff)
downloadzsh-2e9fe98b8a9fe21b982e719e129678dede63771e.tar.gz
zsh-2e9fe98b8a9fe21b982e719e129678dede63771e.tar.bz2
zsh-2e9fe98b8a9fe21b982e719e129678dede63771e.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/magic-enter/Readme.md')
-rw-r--r--plugins/magic-enter/Readme.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/plugins/magic-enter/Readme.md b/plugins/magic-enter/Readme.md
index b401ab415..78514c67d 100644
--- a/plugins/magic-enter/Readme.md
+++ b/plugins/magic-enter/Readme.md
@@ -1,14 +1,17 @@
-## Magic Enter
+## Magic Enter plugin
-**Maintainer:** [@dufferzafar](https://github.com/dufferzafar)
-
-Makes your enter key magical, by binding commonly used commands to it.
+This plugin makes your enter key magical, by binding commonly used commands to it.
-You can set the commands to be run in your .zshrc, before the line containing plugins!
+To use it, add `magic-enter` to the plugins array in your zshrc file. You can set the
+commands to be run in your .zshrc, before the line containing plugins. If no command
+is specified in a git directory, `git status` is executed; in other directories, `ls`.
-```bash
+```zsh
+# defaults
MAGIC_ENTER_GIT_COMMAND='git status -u .'
MAGIC_ENTER_OTHER_COMMAND='ls -lh .'
-plugins=(magic-enter)
+plugins=(... magic-enter)
```
+
+**Maintainer:** [@dufferzafar](https://github.com/dufferzafar)