summaryrefslogtreecommitdiff
path: root/plugins/tmuxinator
diff options
context:
space:
mode:
authorgramps <richmoyer@gmail.com>2018-10-02 14:22:59 -0500
committerGitHub <noreply@github.com>2018-10-02 14:22:59 -0500
commitb67883f9632932dde00c09498eb44ee4f3628288 (patch)
tree9f20e4d87ce04dc9aca8fb51217176610dfa4683 /plugins/tmuxinator
parenta8e69686aa6c782eed3d749de5fb54758de10734 (diff)
downloadzsh-b67883f9632932dde00c09498eb44ee4f3628288.tar.gz
zsh-b67883f9632932dde00c09498eb44ee4f3628288.tar.bz2
zsh-b67883f9632932dde00c09498eb44ee4f3628288.zip
Create README.md
Diffstat (limited to 'plugins/tmuxinator')
-rw-r--r--plugins/tmuxinator/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/plugins/tmuxinator/README.md b/plugins/tmuxinator/README.md
new file mode 100644
index 000000000..25631d095
--- /dev/null
+++ b/plugins/tmuxinator/README.md
@@ -0,0 +1,18 @@
+# Tmuxinator plugin
+
+This plugin provides 4 aliases for 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 |
+| `txo ` | tmuxinator open | Open project for editing |
+| `txn ` | tmuxinator new | Create project |
+| `txl ` | tmuxinator list | List projects |