dash: add README (#8221)

This commit is contained in:
Marc Cornellà 2019-10-07 17:04:55 +02:00 committed by GitHub
commit e0bc646993
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

28
plugins/dash/README.md Normal file
View file

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