summaryrefslogtreecommitdiff
path: root/plugins/tmuxinator
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
committerTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
commit075160b86c64045e661209ad7906559068b44104 (patch)
treea910a6eef6163d39859395bb0b416b2b184db9ac /plugins/tmuxinator
parent5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (diff)
parent3c9942c4884089b290ef750468b29419ca0de271 (diff)
downloadzsh-075160b86c64045e661209ad7906559068b44104.tar.gz
zsh-075160b86c64045e661209ad7906559068b44104.tar.bz2
zsh-075160b86c64045e661209ad7906559068b44104.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/tmuxinator')
-rw-r--r--plugins/tmuxinator/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/tmuxinator/README.md b/plugins/tmuxinator/README.md
new file mode 100644
index 000000000..994d8d46d
--- /dev/null
+++ b/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 |