diff options
Diffstat (limited to 'plugins/magic-enter')
-rw-r--r-- | plugins/magic-enter/README.md | 17 | ||||
-rw-r--r-- | plugins/magic-enter/Readme.md | 14 |
2 files changed, 17 insertions, 14 deletions
diff --git a/plugins/magic-enter/README.md b/plugins/magic-enter/README.md new file mode 100644 index 000000000..78514c67d --- /dev/null +++ b/plugins/magic-enter/README.md @@ -0,0 +1,17 @@ +## Magic Enter plugin + +This plugin 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`. + +```zsh +# defaults +MAGIC_ENTER_GIT_COMMAND='git status -u .' +MAGIC_ENTER_OTHER_COMMAND='ls -lh .' + +plugins=(... magic-enter) +``` + +**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) diff --git a/plugins/magic-enter/Readme.md b/plugins/magic-enter/Readme.md deleted file mode 100644 index b401ab415..000000000 --- a/plugins/magic-enter/Readme.md +++ /dev/null @@ -1,14 +0,0 @@ -## Magic Enter - -**Maintainer:** [@dufferzafar](https://github.com/dufferzafar) - -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! - -```bash -MAGIC_ENTER_GIT_COMMAND='git status -u .' -MAGIC_ENTER_OTHER_COMMAND='ls -lh .' - -plugins=(magic-enter) -``` |