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.