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 |