diff options
| author | Marco Zühlke <mzuehlke@gmail.com> | 2019-10-19 17:39:03 +0200 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2019-10-19 17:39:03 +0200 |
| commit | aebf333b0ce05bb6710729180335957ceed80dd4 (patch) | |
| tree | dd87e76783708b3e34cd83d7002720d31e9aeedf /plugins/magic-enter | |
| parent | 66290a39c82647b3582cbf945ac4c3a08e3c854c (diff) | |
| download | zsh-aebf333b0ce05bb6710729180335957ceed80dd4.tar.gz zsh-aebf333b0ce05bb6710729180335957ceed80dd4.tar.bz2 zsh-aebf333b0ce05bb6710729180335957ceed80dd4.zip | |
magic-enter: update README (#8284)
Diffstat (limited to 'plugins/magic-enter')
| -rw-r--r-- | plugins/magic-enter/Readme.md | 17 |
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) |