aebf333b0ce05bb6710729180335957ceed80dd4

Author
Marco Zühlke <mzuehlke@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

magic-enter: update README (#8284)

Diff

 1diff --git a/plugins/magic-enter/Readme.md b/plugins/magic-enter/Readme.md
 2index b401ab415d0e3ea68c91fd931354c393a7a42630..78514c67d821dbfb8f1f0ceae3d1c7f4eb6fb329 100644
 3--- a/plugins/magic-enter/Readme.md
 4+++ b/plugins/magic-enter/Readme.md
 5@@ -1,14 +1,17 @@
 6-## Magic Enter
 7+## Magic Enter plugin
 8 
 9-**Maintainer:** [@dufferzafar](https://github.com/dufferzafar)
10-
11-Makes your enter key magical, by binding commonly used commands to it.
12+This plugin makes your enter key magical, by binding commonly used commands to it.
13 
14-You can set the commands to be run in your .zshrc, before the line containing plugins!
15+To use it, add `magic-enter` to the plugins array in your zshrc file. You can set the
16+commands to be run in your .zshrc, before the line containing plugins. If no command
17+is specified in a git directory, `git status` is executed; in other directories, `ls`.
18 
19-```bash
20+```zsh
21+# defaults
22 MAGIC_ENTER_GIT_COMMAND='git status -u .'
23 MAGIC_ENTER_OTHER_COMMAND='ls -lh .'
24 
25-plugins=(magic-enter)
26+plugins=(... magic-enter)
27 ```
28+
29+**Maintainer:** [@dufferzafar](https://github.com/dufferzafar)