Merge pull request #3 from mastern2k3/master

Added installation and usage instructions to readme.md

Author: ronenquali

README.md

@@ -1,2 +1,49 @@
 # CloudShell-PyCharm-Plugin
-A plugin for publishing drivers developed with JetBrains PyCharm products to CloudShell 
+A plugin for publishing drivers developed with JetBrains PyCharm products to CloudShell
+
+# How to install Quali PyCharm python driver plugin
+
+When working with Python resource drivers, a plugin enables updating Python drivers straight from PyCharm.  
+If you don't have PyCharm you can get it from here: https://www.jetbrains.com/pycharm/download/
+
+## Step-by-step installation guide
+
+1. First get the latest plugin release from GitHub over here:  
+    https://github.com/QualiSystemsLab/CloudShell-PyCharm-Plugin/releases
+2. Once you have the plugin `.jar` file (`intelli-qs-plugin.jar`) open the settings window from within PyCharm.  
+    Pressing <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>S</kbd> will open the settings window.  
+    ![Settings Window](/docs/images/settings_window.png)
+3. Then, choose "Plugins", and click "Install plugin from disk...".  
+4. Browse and choose to the .jar plugin file (intelli-qs-plugin.jar) you just downloaded.  
+5. Then, click "Restart PyCharm".  
+    ![Restart Button](/docs/images/restart_button.png)
+6. After PyCharm restarts the plugin would be installed.
+
+## Using the Quali python driver plugin
+1. The plugin adds the update and deploy action to two places:
+    1. The module menu, opened up by right clicking the module in the project tool window on the left:  
+        ![Project Tool Window](/docs/images/module_menu.png)
+    2. The run and run toolbar on the top right:  
+        ![Runner Actions](/docs/images/build_menu.png)
+
+2. Before running the plugin, you'll need to have a file named `deployment.xml` in the project root folder,  
+    this file tells the plugin how and which driver you're trying to update, you can use this snippet as a template:
+``` xml
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
+<properties>
+<!-- The address of the Quali server on which to deploy, mandatory -->
+<entry key="serverRootAddress">serverRootAddress</entry>
+<!-- The port of the Quali server on which to deploy, defaults to "8029" -->
+<entry key="port">port</entry>
+<!-- The unique name of the driver as seen on the portal management, mandatory -->
+<entry key="driverUniqueName">driverUniqueName</entry>
+<!-- The server admin username, password and domain to use when deploying, defaults to "admin","admin" and "Global" -->
+<entry key="username">username</entry>
+<entry key="password">password</entry>
+<entry key="domain">domain</entry>
+<!-- Simple patterns to filter when sending the driver to the server separated by semicolons (e.g. "file.xml;logs/"),
+    on top of the patterns specified here the plugin will automatically filter the "deployment/" and ".idea/" folders and the "deployment.xml" file -->
+<entry key="fileFilters">fileFilters</entry>
+</properties>
+```