228d7d1041e4f275e792390614b96bebc10759c0
- Author
- MasterOfTheTiger <ted.jameson@pm.me>
- Committer
- Marc Cornellà <marc.cornella@live.com>
- Date
Message
dirhistory: add README (#7239)
Diff
1diff --git a/plugins/dirhistory/README.md b/plugins/dirhistory/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..511f2be178d36436fd8ac3d9f53e8622a717552b
4--- /dev/null
5+++ b/plugins/dirhistory/README.md
6@@ -0,0 +1,17 @@
7+# Dirhistory plugin
8+
9+This plugin adds keyboard shortcuts for navigating directory history and hierarchy.
10+
11+To use it, add `dirhistory` to the plugins array in your zshrc file:
12+
13+```zsh
14+plugins=(... dirhistory)
15+```
16+## Keyboard Shortcuts
17+
18+| Shortcut | Description |
19+|-----------------------------------|-----------------------------------------------------------|
20+| <kbd>alt</kbd> + <kbd>left</kbd> | Go to previous directory |
21+| <kbd>alt</kbd> + <kbd>right</kbd> | Undo <kbd>alt</kbd> + <kbd>left</kbd> |
22+| <kbd>alt</kbd> + <kbd>up</kbd> | Move into the parent directory |
23+| <kbd>alt</kbd> + <kbd>down</kbd> | Move into the first child directory by alphabetical order |