summaryrefslogtreecommitdiff
path: root/plugins/osx/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2016-06-16 00:23:09 +0200
committerMarc Cornellà <marc.cornella@live.com>2016-06-16 00:23:09 +0200
commit46c0d9590d38f98ab7f69f48c067715077fe49cb (patch)
tree3c5f1976f05c6b933236bcde693b9d1f3c8a0920 /plugins/osx/README.md
parent137a554e48263b1517dced417e36836157f062f5 (diff)
downloadzsh-46c0d9590d38f98ab7f69f48c067715077fe49cb.tar.gz
zsh-46c0d9590d38f98ab7f69f48c067715077fe49cb.tar.bz2
zsh-46c0d9590d38f98ab7f69f48c067715077fe49cb.zip
Add README for OSX plugin and refactor plugin file
Diffstat (limited to 'plugins/osx/README.md')
-rw-r--r--plugins/osx/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/osx/README.md b/plugins/osx/README.md
new file mode 100644
index 000000000..a06184a45
--- /dev/null
+++ b/plugins/osx/README.md
@@ -0,0 +1,27 @@
+# OSX plugin
+
+## Description
+
+This plugin provides a few utilities to make it more enjoyable on OSX.
+
+To start using it, add the `osx` plugin to your plugins array in `~/.zshrc`:
+
+```zsh
+plugins=(... osx)
+```
+
+Original author: [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+
+## Commands
+
+| Command | Description |
+|:--------------|:-----------------------------------------------|
+| `tab` | Open the current directory in a new tab |
+| `ofd` | Open the current directory in a Finder window |
+| `pfd` | Return the path of the frontmost Finder window |
+| `pfs` | Return the current Finder selection |
+| `cdf` | `cd` to the current Finder directory |
+| `pushdf` | `pushd` to the current Finder directory |
+| `quick-look` | Quick-Look a specified file |
+| `man-preview` | Open a specified man page in Preview app |