Merge remote-tracking branch 'github/master'HEADmaster

1 files changed, 18 insertions, 0 deletions

diff --git a/plugins/tldr/README.md b/plugins/tldr/README.md
new file mode 100644
index 000000000..03b1dfc73
--- /dev/null
+++ b/plugins/tldr/README.md
@@ -0,0 +1,18 @@
+# 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 |
+
+## Note
+You also need to install ```tldr```.