summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'plugins')
-rw-r--r--plugins/dash/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/dash/README.md b/plugins/dash/README.md
new file mode 100644
index 000000000..f69f834f3
--- /dev/null
+++ b/plugins/dash/README.md
@@ -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
+```