From ff6d111d793970fc522dd3743367a4c3c46f5fc2 Mon Sep 17 00:00:00 2001
From: Christoph Bachhuber <cbachhuber89@gmail.com>
Date: Wed, 11 Mar 2020 18:17:08 +0100
Subject: [PATCH] z: add markdown Readme (#8715)

---
 plugins/z/README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 plugins/z/README.md

diff --git a/plugins/z/README.md b/plugins/z/README.md
new file mode 100644
index 000000000..ea8d4610a
--- /dev/null
+++ b/plugins/z/README.md
@@ -0,0 +1,23 @@
+# z - jump around
+
+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.
+
+### 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 [README](./README) (in man page format, copied from [rupa/z](https://github.com/rupa/z)).
+