Browse Source

Create README.md

gramps 6 years ago
parent
commit
b67883f963
1 changed files with 18 additions and 0 deletions
  1. 18 0
      plugins/tmuxinator/README.md

+ 18 - 0
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            |