awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
streetturtle 2020-01-30 10:32:18 -05:00 committed by GitHub
parent 160219d01e
commit cd80ecd952
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
jira-widget/README.md
View File

@ -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