summaryrefslogtreecommitdiff
path: root/jira-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-01-30 10:32:18 -0500
committerGitHub <noreply@github.com>2020-01-30 10:32:18 -0500
commitcd80ecd952279f1c0e6cba09f4a790e1dbcf911d (patch)
tree7371e243e00c56335e7b2edb9e38db57bb8c2df2 /jira-widget
parent160219d01e307acbf471d8c7a90693a955a80fb4 (diff)
Update README.md
Diffstat (limited to 'jira-widget')
-rw-r--r--jira-widget/README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/jira-widget/README.md b/jira-widget/README.md
index 0613b67..4690fa9 100644
--- a/jira-widget/README.md
+++ b/jira-widget/README.md
@@ -4,7 +4,7 @@ The widget shows the number of assigned tickets to the user and when clicked sh
## How it works
-Widget users cURL to query JIRA's REST API. In order to be authenticated, widget uses netrc [feature](https://ec.haxx.se/usingcurl/usingcurl-netrc) 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. Don't forget to set file permission to 600.
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.
@@ -20,6 +20,20 @@ It is possible to customize widget by providing a table with all or some of the
## Installation
+Create a .netrc file in you home directory with following content:
+
+```bash
+machine turtlejira.com
+login mikey@tmnt.com
+password cowabunga
+```
+
+Then change file's permissions to 600 (so only you can read/write it):
+
+```bash
+chmod 600 ~/.netrc
+```
+
Clone/download repo and use widget in **rc.lua**:
```lua