summaryrefslogtreecommitdiff
path: root/plugins/textmate/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
committerTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
commit89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095 (patch)
tree0a301691b8481163680454a1f07ca54115ec17eb /plugins/textmate/README.md
parent075160b86c64045e661209ad7906559068b44104 (diff)
parent851899e59ea71ce8fbae738ec7aeb7a967585977 (diff)
downloadzsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.gz
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.bz2
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
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..9fd342135
--- /dev/null
+++ 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.