aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index 7ef0b6c..d95f7c6 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,21 @@
# tmux-toggle-term
-A terminal toggle for tmux that supports a per-window split pane and a global floating popup.
+A terminal toggle for tmux that supports a per-window split pane and a global
+floating popup.
## Installation
-Using [TPM](https://github.com/tmux-plugins/tpm):
+Clone to a plugins directory:
-```tmux
-set-option -g @plugin 'https://git.sr.ht/~eugenetriguba/tmux-toggle-term'
+```sh
+git clone https://git.eugenetriguba.com/tmux-toggle-term
+~/.tmux/plugins/tmux-toggle-term
```
-Reload tmux and press prefix + I to install.
+Add to your tmux configuration:
+```tmux
+run-shell '~/.tmux/plugins/tmux-toggle-term/plugin.tmux'
+```
## Usage
@@ -18,13 +23,13 @@ Reload tmux and press prefix + I to install.
`C-;` → Toggle a split terminal for the current tmux window
-![Split Pane](./docs/split-open.webp)
+![Split Pane](https://git.eugenetriguba.com/tmux-toggle-term/plain/docs/split-open.webp)
### Toggle Floating Terminal
`C-f` → Toggle a global floating popup terminal
-![Floating Window](./docs/float-open.webp)
+![Floating Window](https://git.eugenetriguba.com/tmux-toggle-term/plain/docs/float-open.webp)
## Customization