Fix: Improve README.md

Author: Lakshmi Kannan

contrib/sandbox/packages/jira/README.md

@@ -1,3 +1,29 @@
+# JIRA integration
+This pack consists of a sample JIRA sensor and a JIRA action.
+
+## JIRA sensor
+The sensor monitors for new projects and sends a trigger into the system whenever there is a new project.
+
+## JIRA action
+The action script allows you to create a JIRA issue.
+
+## Requirements
+To use either of the sensor or action, following are the dependencies:
+
+1. Python 2.7 or later. (Might work with 2.6. Not tested.) 
+2. pip install jira # installs python JIRA client
+
+## Configuration
+Sensor and action come with a json configuration file (jira_config.json). You'll need to configure the following:
+
+1. JIRA server
+2. OAuth token
+3. OAuth secret
+4. Consumer key
+
+To get these OAuth credentials, take a look at OAuth section. 
+
+## OAuth
 ## Disclaimer
 This documentation is written as of 06/17/2014. JIRA 6.3 implements OAuth1. Most of this doc would need to be revised when JIRA switches to OAuth2.
 
@@ -17,5 +43,5 @@ This documentation is written as of 06/17/2014. JIRA 6.3 implements OAuth1. Most
      * Go to AppLinks section of your JIRA - https://JIRA_SERVER/plugins/servlet/applinks/listApplicationLinks
      * Create a Generic Application with some fake URL
      * Click Edit, hit IncomingAuthentication. Plug in the consumer key and RSA public key you generated.
-4. Get access token using this [script](https://github.com/lakshmi-kannan/jira-oauth-access-token-generator/blob/master/generate_access_token.py)
+4. Get access token using this [script](https://github.com/lakshmi-kannan/jira-oauth-access-token-generator/blob/master/generate_access_token.py). These are the ones that are printed at the last. Save these keys somewhere safe. 
 5. Plug in the access token and access secret into the sensor or action. You are good to make JIRA calls. Note: OAuth token expires. You'll have to repeat the process based on the expiry date.