e0bc646993df69562c1bd45c5655d4df76d86e82

Author
Marc Cornellà <marc.cornella@live.com>
Committer
GitHub <noreply@github.com>
Date

Message

dash: add README (#8221)

Diff

 1diff --git a/plugins/dash/README.md b/plugins/dash/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..0ca3e4e44d7a51fd7a1b174cbb265ee111b85018
 4--- /dev/null
 5+++ b/plugins/dash/README.md
 6@@ -0,0 +1,28 @@
 7+# Dash plugin
 8+
 9+This plugin adds command line functionality for [Dash](https://kapeli.com/dash),
10+an API Documentation Browser for macOS. This plugin requires Dash to be installed
11+to work.
12+
13+To use it, add `dash` to the plugins array in your zshrc file:
14+
15+```zsh
16+plugins=(... dash)
17+```
18+
19+## Usage
20+
21+- Open and switch to the dash application.
22+```
23+dash
24+```
25+
26+- Query for something in dash app: `dash query`
27+```
28+dash golang 
29+```
30+
31+- You can optionally provide a keyword: `dash [keyword:]query`
32+```
33+dash python:tuple
34+```