summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorMasterOfTheTiger <ted.jameson@pm.me>2018-10-05 15:02:47 -0700
committerMarc Cornellà <marc.cornella@live.com>2018-10-06 00:02:47 +0200
commit228d7d1041e4f275e792390614b96bebc10759c0 (patch)
treed1562b8f2f973d9e6435f6522e81df0c27dfe2b8 /plugins
parent9aa8af3d0ce726cddf6e0e702abc5bfd90575257 (diff)
downloadzsh-228d7d1041e4f275e792390614b96bebc10759c0.tar.gz
zsh-228d7d1041e4f275e792390614b96bebc10759c0.tar.bz2
zsh-228d7d1041e4f275e792390614b96bebc10759c0.zip
dirhistory: add README (#7239)
Diffstat (limited to 'plugins')
-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 |