From aebf333b0ce05bb6710729180335957ceed80dd4 Mon Sep 17 00:00:00 2001 From: Marco Zühlke Date: Sat, 19 Oct 2019 17:39:03 +0200 Subject: magic-enter: update README (#8284) --- plugins/magic-enter/Readme.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) (limited to 'plugins/magic-enter/Readme.md') 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) -- cgit v1.2.3-70-g09d2