Updated README.MD

Added small description how the plugin works.
psistorm · Jul 1, 2016 · ca82447 · ca82447
1 parent ba10778
commit ca82447
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
 Keypirinha Plugin: HeidiSQL
 =========
 
+This plugin allows to launch HeidiSQL (either installed or portable) and HeidiSQL sessions directly via Keypirinha. By default the plugin will search for an installed version of HeidiSQL. If you only use a portable version please make use of the configuration files and adjust it according to the documentation in the latter.
+
+The plugin will only add one catalog item to Keypirinha. This item has two functionalities:
+
+1. You can start HeidiSQL by hitting `<ENTER>` on the HeidiSQL catalog item. 
+2. To directly launch HeidiSQL sessions press `<TAB>` or `<SPACE>` on the HeidiSQL catalog item. Afterwards you can filter the existing sessions list by typing parts of the session names just like normal.
 
 
 ## Release Notes: ##