summaryrefslogtreecommitdiff
path: root/plugins/dirhistory/README.md
diff options
context:
space:
mode:
authorKozlov Alexander <badryke@gmail.com>2018-11-16 13:38:43 +0300
committerGitHub <noreply@github.com>2018-11-16 13:38:43 +0300
commit8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch)
treeee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/dirhistory/README.md
parentdd30cf104c9ca42d89d26a134382ca421869ce7e (diff)
parent3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff)
downloadzsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip
Merge branch 'master' into master
Diffstat (limited to 'plugins/dirhistory/README.md')
-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 |