diff --git a/README.md b/README.md index 244370f..1e10552 100644 --- a/README.md +++ b/README.md @@ -56,4 +56,21 @@ Run the following command to reload the completion. unfunction _sfdx && autoload -U _sfdx ``` -Enjoy! \ No newline at end of file +Enjoy! + +## Oh My Zsh + +Users of [Oh My Zsh](https://github.com/robbyrussell/oh-my-zsh) can import this auto-completion as a plugin. To install it, just clone this repository into the custom plugins folder. + +```console +git clone git@github.com:wadewegner/salesforce-cli-zsh-completion.git ~/.oh-my-zsh/custom/plugins/salesforce-cli-zsh-completion +``` + +Enable it by editing `~/.zshrc`. Add `salesforce-cli-zsh-completion` to the list of extra plugins, like this: + +```sh +# ~/.zshrc +plugins=(salesforce-cli-zsh-completion) +``` + +Reload your shell and enjoy. diff --git a/salesforce-cli-zsh-completion.plugin.zsh b/salesforce-cli-zsh-completion.plugin.zsh new file mode 100755 index 0000000..5117e93 --- /dev/null +++ b/salesforce-cli-zsh-completion.plugin.zsh @@ -0,0 +1,8 @@ +# This is a placeholder file that allows [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) +# to autoload this code as a plugin. +# +# To install, move this directory to: +# ~/.oh-my-zsh/custom/plugins/salesforce-cli-zsh-completion +# +# And edit ~/.zshrc: +# plugins=(salesforce-cli-zsh-completion)