diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-10-07 17:04:31 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-07 17:04:31 +0200 |
| commit | 357336bfb399ac95db21ceed40dc7b18eea6779c (patch) | |
| tree | 44b23dd8cba435477ef5a30aa4830d54a7979516 /plugins/dash | |
| parent | 4b65f439e2c92b7c839dd355f8701d72f3a8ea2b (diff) | |
| download | zsh-357336bfb399ac95db21ceed40dc7b18eea6779c.tar.gz zsh-357336bfb399ac95db21ceed40dc7b18eea6779c.tar.bz2 zsh-357336bfb399ac95db21ceed40dc7b18eea6779c.zip | |
Remove redundant section and document keyword args
Diffstat (limited to 'plugins/dash')
| -rw-r--r-- | plugins/dash/README.md | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/plugins/dash/README.md b/plugins/dash/README.md index f69f834f3..0ca3e4e44 100644 --- a/plugins/dash/README.md +++ b/plugins/dash/README.md @@ -1,9 +1,8 @@ # 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. +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: @@ -11,19 +10,19 @@ To use it, add `dash` to the plugins array in your zshrc file: plugins=(... dash) ``` -Make sure to source your rc file: -``` -source ~/.zshrc -``` - ## Usage -Open and switch to the dash application. +- Open and switch to the dash application. ``` dash ``` -Query for something in dash app. +- Query for something in dash app: `dash query` +``` +dash golang +``` + +- You can optionally provide a keyword: `dash [keyword:]query` ``` -dash golang +dash python:tuple ``` |