aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-08-16 08:26:57 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-08-16 08:26:57 -0400
commitf91a7f6cf37202841224724614d5051378ea57be (patch)
tree9cba206169e9bffa1b0e9f4883bc6b65cdc86b20 /README.md
downloadtmux-toggle-term-f91a7f6cf37202841224724614d5051378ea57be.zip
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d38da9f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# tmux-toggle-term
+
+A terminal toggle for tmux that supports a per-window split pane and global floating popups.
+
+## Installation
+
+Using [TPM](https://github.com/tmux-plugins/tpm):
+
+```tmux
+set -g @plugin 'git.sr.ht/~eugenetriguba/tmux-toggle-term'
+```
+
+Reload tmux and press prefix + I to install.
+
+## Usage
+
+- `C-;` → Toggle a split terminal for the current tmux window
+- `C-f` → Toggle a global floating popup terminal
+
+You can override the default hotkeys if desired:
+```tmux
+set -g @toggle_term_key 'M-t'
+set -g @toggle_term_float_key 'M-f'
+```
+