From 4b65f439e2c92b7c839dd355f8701d72f3a8ea2b Mon Sep 17 00:00:00 2001 From: Michael C Date: Sun, 6 Oct 2019 15:33:06 +0200 Subject: [PATCH] docs: add README.md for Dash plugin --- plugins/dash/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 plugins/dash/README.md 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 +```