Skip to content

Commit 7a3da50

Browse files
committed
Document installation via ZSH frameworks
Add a section to README.md that details installing it with the three most commonly used ZSH frameworks. Signed-off-by: Joe Block <[email protected]>
1 parent 3a463d2 commit 7a3da50

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# iTerm2-shell-integration
22
Shell integration and utilities for iTerm2
3+
4+
## ZSH framework usage
5+
6+
The repository contains `iTerm2-shell-integration.plugin.zsh` to make it easier to use with ZSH frameworks like zgenom, antigen and oh-my-zsh.
7+
8+
### [Zgenom](https://github.com/jandamm/zgenom)
9+
10+
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.
11+
12+
### [Antigen](https://github.com/zsh-users/antigen)
13+
14+
Add `antigen bundle gnachman/iTerm2-shell-integration@main` to your `.zshrc`
15+
16+
**Note** that until <https://github.com/zsh-users/antigen/issues/717> gets fixed in Antigen, it only automatically recognizes plugins on the `master` branch, so you need to explicitly specify `@main` here.
17+
18+
### [Oh-My-Zsh](http://ohmyz.sh/)
19+
20+
1. `git clone --depth 1 https://github.com/gnachman/iTerm2-shell-integration.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/fzf-zsh-plugin`
21+
2. Add **iterm2-shell-integration** to your plugin list - edit `~.zshrc` and change `plugins=(...)` to `plugins=(... iterm2-shell-integration)`

0 commit comments

Comments
 (0)