Added a README file for the man plugin

8 years ago · 530759d5a0
parent 6fecbf6ad5
commit 530759d5a0
1 changed files with 13 additions and 0 deletions
--- a/plugins/man/README.md
+++ b/plugins/man/README.md
@ -0,0 +1,13 @@
+# Man plugin
+
+This plugin adds a shortcut to insert man before the previous command.
+
+To use it, add `man` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... man)
+```
+# Keyboard Shortcuts
+| Shortcut                          | Description                                                            |
+|-----------------------------------|------------------------------------------------------------------------|
+| <kpd>esc</kpd> + man              | add man before the previous command to see the manual for this command |