magic-enter: update README (#8284)

This commit is contained in:
Marco Zühlke 2019-10-19 17:39:03 +02:00 committed by Marc Cornellà
parent 66290a39c8
commit aebf333b0c
1 changed files with 10 additions and 7 deletions

View File

@ -1,14 +1,17 @@
## Magic Enter
## Magic Enter plugin
**Maintainer:** [@dufferzafar](https://github.com/dufferzafar)
This plugin makes your enter key magical, by binding commonly used commands to it.
Makes your enter key magical, by binding commonly used commands to it.
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`.
You can set the commands to be run in your .zshrc, before the line containing plugins!
```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)