diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-10-07 17:04:55 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-07 17:04:55 +0200 |
| commit | e0bc646993df69562c1bd45c5655d4df76d86e82 (patch) | |
| tree | 44b23dd8cba435477ef5a30aa4830d54a7979516 /plugins | |
| parent | 3848102a5ec8534cef935d594c6abcbfc0f419c8 (diff) | |
| parent | 357336bfb399ac95db21ceed40dc7b18eea6779c (diff) | |
| download | zsh-e0bc646993df69562c1bd45c5655d4df76d86e82.tar.gz zsh-e0bc646993df69562c1bd45c5655d4df76d86e82.tar.bz2 zsh-e0bc646993df69562c1bd45c5655d4df76d86e82.zip | |
dash: add README (#8221)
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/dash/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/plugins/dash/README.md b/plugins/dash/README.md new file mode 100644 index 000000000..0ca3e4e44 --- /dev/null +++ b/plugins/dash/README.md @@ -0,0 +1,28 @@ +# Dash plugin + +This plugin adds command line functionality for [Dash](https://kapeli.com/dash), +an API Documentation Browser for macOS. 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) +``` + +## Usage + +- Open and switch to the dash application. +``` +dash +``` + +- Query for something in dash app: `dash query` +``` +dash golang +``` + +- You can optionally provide a keyword: `dash [keyword:]query` +``` +dash python:tuple +``` |