diff --git a/README.md b/README.md index ac09ed2..a0ff30f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # iTerm2-shell-integration Shell integration and utilities for iTerm2 + +## ZSH framework usage + +The repository contains `iTerm2-shell-integration.plugin.zsh` to make it easier to use with ZSH frameworks like zgenom, antigen and oh-my-zsh. + +### [Zgenom](https://github.com/jandamm/zgenom) + +Add `zgenom load gnachman/iTerm2-shell-integration` to your `.zshrc` with your other load commands, then run `zgenom save` to update its `init.zsh` file. The integration will be automatically loaded the next time you start a ZSH session. + +### [Antigen](https://github.com/zsh-users/antigen) + +Add `antigen bundle gnachman/iTerm2-shell-integration@main` to your `.zshrc` + +☝ **Note** that until gets fixed in Antigen, it only automatically recognizes plugins on the `master` branch, so you need to explicitly specify `@main` here. + +### [Oh-My-Zsh](http://ohmyz.sh/) + +1. `git clone --depth 1 https://github.com/gnachman/iTerm2-shell-integration.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/fzf-zsh-plugin` +2. Add **iterm2-shell-integration** to your plugin list - edit `~.zshrc` and change `plugins=(...)` to `plugins=(... iterm2-shell-integration)` diff --git a/iTerm2-shell-integration.plugin.zsh b/iTerm2-shell-integration.plugin.zsh new file mode 100644 index 0000000..0b48a8a --- /dev/null +++ b/iTerm2-shell-integration.plugin.zsh @@ -0,0 +1,7 @@ +# Automagically add the utilities directory to $PATH + +# Add utilities to our path +path+=("${0:h}/utilities") + +# And source the helper functions, too. +source "${0:h}/shell_integration/zsh"