textmate: add README (#7267)

ohmyzsh · Oct 14, 2018 · 489be24 · 489be24
2 parents 793ee0f + 5df484d
commit 489be24
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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.