Browse Source

docs: add README.md for Dash plugin

Michael C 4 years ago
parent
commit
4b65f439e2
1 changed files with 29 additions and 0 deletions
  1. 29 0
      plugins/dash/README.md

+ 29 - 0
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
+```