Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gdelmas committed Dec 14, 2017
1 parent cd46ca0 commit 21fe246
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@
<vendor url="https://github.com/gdelmas/IntelliJDashPlugin">Gerard Delmàs</vendor>

<description><![CDATA[
<p>A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm and Android Studio.</p>
<p>A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm, DataGrip, CLion, GoLand and Android Studio.</p>
<p><h2><b>Usage</b></h2></p>
<p>The default <b>shortcut</b> assigned to search is <b>Cmd-Shift-D</b> (Mac OS X) or <b>Ctrl-Shift-D</b> (Windows, Linux).</p>
<p>A <b>menubar command</b> named either "<b>Search in Dash</b>" (Mac OS X), "Search in Velocity" (Windows) or "Search in Zeal" (Linux) can be found in the "Tools" menu.</p>
<p>A <b>menubar command</b> named either "<b>Search Documentation</b>" can be found in the "Tools" menu.</p>
<p>The plugin either searches for the statement at caret position or the current selection. It will identify the programming language in use and request filtered results accordingly.</p>
<p><h2><b>Configuration</b></h2></p>
<h3><b>Shortcut</b></h3>
<p>You can change the shortcut at Preferences -&gt; Keymap -&gt; Plug-ins -&gt; Dash.</p>
<h3><b>Toolbar Icon</b></h3>
<p>You can add a "Search in Dash/Velocity/Zeal" button to the toolbar. Right-click the menubar -&gt; Customize […]. You will find the button under "Plug-ins -&gt; Dash".</p>
<p>You can add a "Search Documentation" button to the toolbar. Right-click the menubar -&gt; Customize […]. You will find the button under "Plug-ins -&gt; Dash".</p>
<p><h2><b>Supported API Documentation Browsers</b></h2></p>
<h3><b>Kapeli Dash (Mac OS X)</b></h3>
<p>Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 150+ APIs (for a full list, see below). You can even generate your own docsets or request docsets to be included. <a href="http://kapeli.com/dash">http://kapeli.com/dash</a></p>
<h3><b>Velocity (Windows)</b></h3>
<p>Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OS X). <a href="https://velocity.silverlakesoftware.com">https://velocity.silverlakesoftware.com</a></p>
<h3><b>Zeal (Linux)</b></h3>
<h3><b>Zeal (Linux &amp; Windows)</b></h3>
<p>Zeal is a simple offline API documentation browser inspired by Dash (OS X app). <a href="http://zealdocs.org">http://zealdocs.org</a></p>
]]></description>

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm and Android Studio.
A smart and simple plugin that provides keyboard shortcut access for Dash, Velocity or Zeal in IntelliJ IDEA, RubyMine, WebStorm, PhpStorm, PyCharm, DataGrip, CLion, GoLand and Android Studio.

## Installation
To install the plugin in your IDE go to **Preferences -> Plugins -> Browse repositories** and **search for "Dash"**.
Expand All @@ -7,7 +7,7 @@ To install the plugin in your IDE go to **Preferences -> Plugins -> Browse repos
The default **shortcut** assigned to search is **Cmd-Shift-D** (Mac OS X) or **Ctrl-Shift-D** (Windows, Linux).


A **menubar command** named either "**Search in Dash**" (Mac OS X), "Search in Velocity" (Windows) or "Search in Zeal" (Linux) can be found in the "Tools" menu.
A **menubar command** named "**Search Documentation**" can be found in the "Tools" menu.


The plugin either searches for the statement at caret position or the current selection. It will identify the programming language in use and request filtered results accordingly.
Expand All @@ -17,7 +17,7 @@ The plugin either searches for the statement at caret position or the current se
You can change the shortcut at Preferences -> Keymap -> Plug-ins -> Dash.

### Toolbar Icon
You can add a "Search in Dash/Velocity/Zeal" button to the toolbar. Right-click the menubar -> Customize []. You will find the button under "Plug-ins -> Dash".
You can add a "Search Documentation" button to the toolbar. Right-click the menubar -> Customize []. You will find the button under "Plug-ins -> Dash".

## Supported API Documentation Browsers
### Kapeli Dash (Mac OS X)
Expand All @@ -28,7 +28,7 @@ Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snipp
Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OS X).
[https://velocity.silverlakesoftware.com](https://velocity.silverlakesoftware.com)

### Zeal (Linux)
### Zeal (Linux & Windows)
Zeal is a simple offline API documentation browser inspired by Dash (OS X app).
[http://zealdocs.org](http://zealdocs.org)

Expand Down

0 comments on commit 21fe246

Please sign in to comment.