diff options
Diffstat (limited to 'plugins/tldr/README.md')
| -rw-r--r-- | plugins/tldr/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/tldr/README.md b/plugins/tldr/README.md new file mode 100644 index 000000000..fb91d9d1f --- /dev/null +++ b/plugins/tldr/README.md @@ -0,0 +1,15 @@ +# tldr plugin + +This plugin adds a shortcut to insert tldr before the previous command. +Heavily inspired from [Man plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/man). + +To use it, add `tldr` to the plugins array in your zshrc file: + +```zsh +plugins=(... tldr) +``` + +# Keyboard Shortcuts +| Shortcut | Description | +|------------------------------------|----------------------------------------------------------------------------| +| <kbd>Esc</kbd> + tldr | add tldr before the previous command to see the tldr page for this command | |