summaryrefslogtreecommitdiff
path: root/plugins/textmate
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-10-14 19:41:37 +0200
committerGitHub <noreply@github.com>2018-10-14 19:41:37 +0200
commit489be2452a6410a2c7837910c4cd3c0ed47a7481 (patch)
tree6e2ac292da11e20c2d5e29a410ca8a140ff020dc /plugins/textmate
parent793ee0ffa84ef1f582bb56f53374ce15fea6e09d (diff)
parent5df484d5054d282ba2aedff1785ad92eb7106bac (diff)
downloadzsh-489be2452a6410a2c7837910c4cd3c0ed47a7481.tar.gz
zsh-489be2452a6410a2c7837910c4cd3c0ed47a7481.tar.bz2
zsh-489be2452a6410a2c7837910c4cd3c0ed47a7481.zip
textmate: add README (#7267)
Diffstat (limited to 'plugins/textmate')
-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.