diff options
author | Marc Cornellà <marc.cornella@live.com> | 2019-12-27 02:37:27 +0100 |
---|---|---|
committer | Marc Cornellà <marc.cornella@live.com> | 2019-12-27 02:37:27 +0100 |
commit | 67b5bfaaa316212221a01d4fe2eedcd0fc64c230 (patch) | |
tree | 5c6f76ef95b48a7c7acf6c9c3d0b1c2e2fd53b62 /plugins/magic-enter/README.md | |
parent | 8ea20fdca794a2a2c2f39cebd1e1861f9f0c6fbb (diff) | |
download | zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.gz zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.tar.bz2 zsh-67b5bfaaa316212221a01d4fe2eedcd0fc64c230.zip |
Rename some plugin READMEs for consistency
Diffstat (limited to 'plugins/magic-enter/README.md')
-rw-r--r-- | plugins/magic-enter/README.md | 17 |
1 files changed, 17 insertions, 0 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) |