summaryrefslogtreecommitdiff
path: root/plugins/textmate/README.md
diff options
context:
space:
mode:
authorBrian Mitchell <bman4789@gmail.com>2018-10-10 23:04:01 -0500
committerGitHub <noreply@github.com>2018-10-10 23:04:01 -0500
commitdd3c95c61595ba28e88971ec6480145877e979ca (patch)
tree8e4a61ea64269b53fe6a266f7325fb65b068072d /plugins/textmate/README.md
parent6fecbf6ad5fc6e78dcfd89227cf8b12305b1f8bc (diff)
downloadzsh-dd3c95c61595ba28e88971ec6480145877e979ca.tar.gz
zsh-dd3c95c61595ba28e88971ec6480145877e979ca.tar.bz2
zsh-dd3c95c61595ba28e88971ec6480145877e979ca.zip
Add README for textmate plugin
Diffstat (limited to 'plugins/textmate/README.md')
-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. |