summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/tmuxinator/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/tmuxinator/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/tmuxinator/README.md')
-rw-r--r--oh-my-zsh/plugins/tmuxinator/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/tmuxinator/README.md b/oh-my-zsh/plugins/tmuxinator/README.md
new file mode 100644
index 0000000..8709204
--- /dev/null
+++ b/oh-my-zsh/plugins/tmuxinator/README.md
@@ -0,0 +1,19 @@
+# Tmuxinator plugin
+
+This plugin provides completion for [tmuxinator](https://github.com/tmuxinator/tmuxinator),
+as well as aliases for frequent tmuxinator commands.
+
+To use it add `tmuxinator` to the plugins array in your zshrc file.
+
+```zsh
+plugins=(... tmuxinator)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+| ----- | ---------------- | ------------------------ |
+| `txs` | tmuxinator start | Start Tmuxinator |
+| `txo` | tmuxinator open | Open project for editing |
+| `txn` | tmuxinator new | Create project |
+| `txl` | tmuxinator list | List projects |