textmate: add README (#7267)

2018-10-14 19:41:37 +02:00 · 2018-10-14 19:41:37 +02:00 · 489be2452a
parent 793ee0ffa8 5df484d505
commit 489be2452a
1 changed files with 16 additions and 0 deletions
--- a/plugins/textmate/README.md
+++ b/plugins/textmate/README.md
@ -0,0 +1,16 @@
+# TextMate plugin
+
+The plugin adds a function for the [TextMate](https://macromates.com) editor.
+
+To use it, add `textmate` to the plugins array of your zshrc file:
+```
+plugins=(... textmate)
+```
+
+## Function
+
+The `tm` function provides the following options:
+
+- No arguments: Run `mate` in the current directory.
+- Argument that is a directory: Run `mate` in the given directory and cd to it.
+- Other arguments: Pass all arguments to `mate`. This allows for easy opening of multiple files.