Browse Source

Add README for textmate plugin

Brian Mitchell 6 years ago
parent
commit
dd3c95c615
1 changed files with 16 additions and 0 deletions
  1. 16 0
      plugins/textmate/README.md

+ 16 - 0
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. |