summaryrefslogtreecommitdiff
path: root/plugins/dirhistory
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/dirhistory')
-rw-r--r--plugins/dirhistory/README.md17
1 files changed, 17 insertions, 0 deletions
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 |