4b65f439e2c92b7c839dd355f8701d72f3a8ea2b
- Author
- Michael C <rm.cuffaro@gmail.com>
- Committer
- Michael C <rm.cuffaro@gmail.com>
- Date
Message
docs: add README.md for Dash plugin
Diff
1diff --git a/plugins/dash/README.md b/plugins/dash/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..f69f834f3b38f008ddc35eac54bce8509fc6d3f3
4--- /dev/null
5+++ b/plugins/dash/README.md
6@@ -0,0 +1,29 @@
7+# Dash plugin
8+
9+This plugin adds command line functionality for [Dash](https://kapeli.com/dash),
10+an API Documentation Browser.
11+
12+This plugin requires Dash to be installed to work.
13+
14+To use it, add `dash` to the plugins array in your zshrc file:
15+
16+```zsh
17+plugins=(... dash)
18+```
19+
20+Make sure to source your rc file:
21+```
22+source ~/.zshrc
23+```
24+
25+## Usage
26+
27+Open and switch to the dash application.
28+```
29+dash
30+```
31+
32+Query for something in dash app.
33+```
34+dash golang
35+```