Skip to content

Commit fe1f6c4

Browse files
committed
docs(readme): add TPM installation instructions
1 parent d147958 commit fe1f6c4

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Which will yield a Tmux window looking like this:
5151

5252
## Installation
5353

54+
### Manual
55+
5456
Clone the repo to your machine:
5557

5658
git clone https://github.com/jimeh/tmuxifier.git ~/.tmuxifier
@@ -76,12 +78,28 @@ set path = ( "~/.tmuxifier/bin" $path )
7678
set -gx PATH "~/.tmuxifier/bin" $PATH
7779
```
7880

79-
### Custom Installation Path
81+
#### Custom Installation Path
8082

8183
To install Tmuxifier somewhere else than the suggested `~/.tmuxifier`, simply
8284
clone the repository to your custom location, and ensure the `bin` folder is
8385
added to your PATH making the `tmuxifier` executable available to you.
8486

87+
### TPM
88+
89+
You can also install and update Tmuxifier with
90+
[TPM](https://github.com/tmux-plugins/tpm):
91+
92+
```bash
93+
set -g @plugin 'jimeh/tmuxifier'
94+
```
95+
96+
Trigger TPM's install command with `prefix` + `I` to install Tmuxifier to TPM's
97+
plugin directory (default is `$HOME/.tmux/plugins`).
98+
99+
To use the `tmuxifier` command, you will need to add the `bin` directory to your
100+
PATH. If you are using the default TPM plugin directory, the `bin` directory
101+
will be `$HOME/.tmux/plugins/tmuxifier/bin`.
102+
85103
## Setup
86104

87105
**In bash & zsh:**

0 commit comments

Comments
 (0)