summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/z/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/z/README.md')
-rw-r--r--oh-my-zsh/plugins/z/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/z/README.md b/oh-my-zsh/plugins/z/README.md
new file mode 100644
index 0000000..5b7d6f6
--- /dev/null
+++ b/oh-my-zsh/plugins/z/README.md
@@ -0,0 +1,24 @@
+# z - jump around
+
+This plugin defines the [z command](https://github.com/agkozak/zsh-z) that tracks your most visited directories and allows you to access them with very few keystrokes.
+
+### Example
+
+Assume that you have previously visited directory `~/.oh-my-zsh/plugins`. From any folder in your command line, you can quickly access it by using a regex match to this folder:
+
+```bash
+/usr/bin$ z plug # Even 'z p' might suffice
+~/.oh-my-zsh/plugins$
+```
+
+### Setup
+
+To enable z, add `z` to your `plugins` array in your zshrc file:
+
+```zsh
+plugins=(... z)
+```
+
+### Further reading
+
+For advanced usage and details of z, see [MANUAL](./MANUAL.md) (copied from [agkozak/zsh-z](https://github.com/agkozak/zsh-z)).