From 228d7d1041e4f275e792390614b96bebc10759c0 Mon Sep 17 00:00:00 2001
From: MasterOfTheTiger <ted.jameson@pm.me>
Date: Fri, 5 Oct 2018 15:02:47 -0700
Subject: [PATCH] dirhistory: add README (#7239)

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

diff --git a/plugins/dirhistory/README.md b/plugins/dirhistory/README.md
new file mode 100644
index 000000000..511f2be17
--- /dev/null
+++ b/plugins/dirhistory/README.md
@@ -0,0 +1,17 @@
+# Dirhistory plugin
+
+This plugin adds keyboard shortcuts for navigating directory history and hierarchy.
+
+To use it, add `dirhistory` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... dirhistory)
+```
+## Keyboard Shortcuts
+
+| Shortcut                          | Description                                               |
+|-----------------------------------|-----------------------------------------------------------|
+| <kbd>alt</kbd> + <kbd>left</kbd>  | Go to previous directory                                  |
+| <kbd>alt</kbd> + <kbd>right</kbd> | Undo <kbd>alt</kbd> + <kbd>left</kbd>                     |
+| <kbd>alt</kbd> + <kbd>up</kbd>    | Move into the parent directory                            |
+| <kbd>alt</kbd> + <kbd>down</kbd>  | Move into the first child directory by alphabetical order |