ff6d111d793970fc522dd3743367a4c3c46f5fc2

Author
Christoph Bachhuber <cbachhuber89@gmail.com>
Committer
GitHub <noreply@github.com>
Date

Message

z: add markdown Readme (#8715)

Diff

 1diff --git a/plugins/z/README.md b/plugins/z/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..ea8d4610a038ed380928eb0fea47c9b2ee382fc0
 4--- /dev/null
 5+++ b/plugins/z/README.md
 6@@ -0,0 +1,23 @@
 7+# z - jump around
 8+
 9+This plugin defines the [z command](https://github.com/rupa/z) that tracks your most visited directories and allows you to access them with very few keystrokes.
10+
11+### Example
12+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:
13+
14+```bash
15+/usr/bin$ z plug  # Even 'z p' might suffice
16+~/.oh-my-zsh/plugins$
17+```
18+
19+### Setup
20+To enable z, add `z` to your `plugins` array in your zshrc file:
21+
22+```zsh
23+plugins=(... z)
24+```
25+
26+### Further reading
27+
28+For advanced usage and details of z, see [README](./README) (in man page format, copied from [rupa/z](https://github.com/rupa/z)).
29+