01de53fff3035dbfb87ca4940f1d91208f537a37

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

tmuxinator: add README (#7189)

Diff

 1diff --git a/plugins/tmuxinator/README.md b/plugins/tmuxinator/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..994d8d46d9b4eaca95756a83967f1461924c0a9d
 4--- /dev/null
 5+++ b/plugins/tmuxinator/README.md
 6@@ -0,0 +1,19 @@
 7+# Tmuxinator plugin
 8+
 9+This plugin provides completion for [tmuxinator](https://github.com/tmuxinator/tmuxinator),
10+as well as aliases for frequent tmuxinator commands.
11+
12+To use it add `tmuxinator` to the plugins array in your zshrc file.
13+
14+```zsh
15+plugins=(... tmuxinator)
16+```
17+
18+## Aliases
19+
20+| Alias  | Command          | Description              |
21+| ------ | ---------------- | ------------------------ |
22+| `txs ` | tmuxinator start | Start Tmuxinator         |
23+| `txo ` | tmuxinator open  | Open project for editing |
24+| `txn ` | tmuxinator new   | Create project           |
25+| `txl ` | tmuxinator list  | List projects            |