updated readme as per #10;

enhanced deploy script with a new package; changed Jira Hostname label for clarity; added Options link when connection fails;
alfeugds · May 13, 2018 · 5a31748 · 5a31748
1 parent c345643
commit 5a31748
Show file tree

Hide file tree

Showing 9 changed files with 286 additions and 93 deletions.
diff --git a/.gitignore b/.gitignore
@@ -62,6 +62,7 @@ typings/
 
 # dotenv environment variables file
 .env
+oauth.txt
 
 # package output
-chrome-extension.zip
+chrome-extension.zip
diff --git a/README.md b/README.md
@@ -25,11 +25,15 @@ You can also omit the Jira # and time spent and add it later.
 * Supports SAML and Basic Authentication with Jira app token.
 
 ## Getting Started
-Before using it, you need to open the **Options** page and configure the Jira URL, which needs to point to the API services. For example: `http://<Your Jira URL>/rest/api/2/search`.
+Before using it, you need to do two things:
+- Make sure you are logged in to your Jira instance in Chrome. The extension leverages the existing authentication cookie when it is present in the browser;
+- Open the **Options** page and configure the **Jira Hostname**, which needs to point to the API services*. For example: **`https://jira.atlassian.com`**.
 
 After that, click **Test Connection** to make sure the extension can reach Jira correctly. If so, click **Save** and you are good to go.
 
-If by only providing the Jira URL the connection fails, you'll need to configure the Basic Authentication with your user and password. Also, depending on the authentication method of the Jira API, you'll also need to provide an app token. If that's the case, please consult your IT department to get one.
+If by only providing the Jira Hostname the connection fails, you'll need to configure the **Basic Authentication** with your user and password. Also, depending on the authentication method of the Jira API, you'll also need to provide an app token. If that's the case, please consult your IT department to get one.
+
+*_The extension uses the **Jira Hostname** to build the URL and API calls to the Jira instance like this: **`https://jira.atlassian.com/`**`rest/api/2/search`._
 
 ## Some Images
 

diff --git a/chrome-extension/manifest.json b/chrome-extension/manifest.json
@@ -1,7 +1,7 @@
 {
   "manifest_version": 2,
   "name": "Jira Worklog Tool",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "author": "alfeugds",
   "description": "This extension allows the user to log the work in Jira easily.",
   "homepage_url": "https://github.com/alfeugds/jiraworklogtool",

diff --git a/chrome-extension/options.html b/chrome-extension/options.html
@@ -32,7 +32,7 @@
 <body>
     <div id="container">
         <h3>Configure Jira Connection</h3>
-        <label for="jiraUrl">Jira URL</label>
+        <label for="jiraUrl">Jira Hostname</label>
         <input type="text" id="jiraUrl" />
         <br/>
         <button id="testConnection">Test Connection</button>

diff --git a/chrome-extension/popup.html b/chrome-extension/popup.html
@@ -292,7 +292,7 @@ <h2>Total: <span id="totalHours">2h</span></h2>
     <div id="status" class="hidden"></div>
   </div>
   <div class="error_status hidden">
-    <h2>Please go to <a target="_blank" href="options.html">Options</a> and make sure you are logged in Jira, and the Jira URL is correct.</h2>
+    <h2>Please go to <a target="_blank" href="options.html">Options</a> and make sure you are logged in Jira, and the Jira Hostname is correct.</h2>
   </div>
   <div id="loading" class="hidden">
     <img class="hidden" src="spinner-small.gif" aria-hidden="true" />