summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--plugins/textmate/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/textmate/README.md b/plugins/textmate/README.md
new file mode 100644
index 000000000..8f86d35af
--- /dev/null
+++ b/plugins/textmate/README.md
@@ -0,0 +1,16 @@
+# TextMate plugin
+
+The plugin adds aliases for the [TextMate](https://macromates.com) editor.
+
+To use it, add `textmate` to the plugins array of your zshrc file:
+```
+plugins=(... textmate)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-----------------|-------------|---------------|
+| tm | `mate .` | Open TextMate in the current directory. |
+| tm \<directory> | `mate <directory>` `cd <directory>` | Open TextMate in the given directory and cd to it. |
+| tm <*> | `mate "$@"` | Pass all arguments to `mate`. This allows for easy opening of multiple files. |