docs: add README.md for Dash plugin

This commit is contained in:
Michael C 2019-10-06 15:33:06 +02:00
parent 3848102a5e
commit 4b65f439e2
1 changed files with 29 additions and 0 deletions

29
plugins/dash/README.md Normal file
View File

@ -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
```