summaryrefslogtreecommitdiff
path: root/jira-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2020-02-02 13:55:49 -0500
committerstreetturtle <streetturtle@gmail.com>2020-02-02 13:55:49 -0500
commitcc124d636ca887323a628595e7dea3336c211539 (patch)
treea2fc9460f16a15134b552d7c0bbd8330450dd44e /jira-widget
parentfa2774591f14856521687013d121e0abc5087cd3 (diff)
Improve readme
Diffstat (limited to 'jira-widget')
-rw-r--r--jira-widget/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/jira-widget/README.md b/jira-widget/README.md
index fef7eeb..11ca483 100644
--- a/jira-widget/README.md
+++ b/jira-widget/README.md
@@ -1,12 +1,12 @@
# Jira widget
-The widget shows the number of assigned tickets to the user and when clicked shows them in the list with some additional information. When item in the list is clicked - it opens the issue in browser
+The widget shows the number of tickets assigned to the user and when clicked shows them in the list with some additional information. When item in the list is clicked - it opens the issue in browser.
## How it works
-Widget uses cURL to query JIRA's [REST API](https://developer.atlassian.com/server/jira/platform/rest-apis/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder. Don't forget to set file permission to 600.
+Widget uses cURL to query Jira's [REST API](https://developer.atlassian.com/server/jira/platform/rest-apis/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder.
-If you are on Attlassian Cloud, then instead of providing a password in netrc file you can set an [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) which is a safer option, as you can revoke/change the token at any time.
+If you are on Atlassian Cloud, then instead of providing a password in netrc file you can set an [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) which is a safer option, as you can revoke/change the token at any time.
## Customization