diff options
| author | Michael C <rm.cuffaro@gmail.com> | 2019-10-06 15:33:06 +0200 |
|---|---|---|
| committer | Michael C <rm.cuffaro@gmail.com> | 2019-10-07 07:08:17 +0200 |
| commit | 4b65f439e2c92b7c839dd355f8701d72f3a8ea2b (patch) | |
| tree | f25b802c57c718ba860a72a6598ea929029d2549 /plugins/dash | |
| parent | 3848102a5ec8534cef935d594c6abcbfc0f419c8 (diff) | |
| download | zsh-4b65f439e2c92b7c839dd355f8701d72f3a8ea2b.tar.gz zsh-4b65f439e2c92b7c839dd355f8701d72f3a8ea2b.tar.bz2 zsh-4b65f439e2c92b7c839dd355f8701d72f3a8ea2b.zip | |
docs: add README.md for Dash plugin
Diffstat (limited to 'plugins/dash')
| -rw-r--r-- | plugins/dash/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/dash/README.md b/plugins/dash/README.md new file mode 100644 index 000000000..f69f834f3 --- /dev/null +++ b/plugins/dash/README.md @@ -0,0 +1,29 @@ +# Dash plugin + +This plugin adds command line functionality for [Dash](https://kapeli.com/dash), +an API Documentation Browser. + +This plugin requires Dash to be installed to work. + +To use it, add `dash` to the plugins array in your zshrc file: + +```zsh +plugins=(... dash) +``` + +Make sure to source your rc file: +``` +source ~/.zshrc +``` + +## Usage + +Open and switch to the dash application. +``` +dash +``` + +Query for something in dash app. +``` +dash golang +``` |