diff options
| author | streetturtle <streetturtle@gmail.com> | 2021-04-12 20:53:44 -0400 |
|---|---|---|
| committer | streetturtle <streetturtle@gmail.com> | 2021-04-12 20:55:05 -0400 |
| commit | 7ea3eec17924a814ec3109958ba9d2db50e87ffd (patch) | |
| tree | 23ad60b85b27c94ff10f2e295a4b64d40db6a6b6 /jira-widget/README.md | |
| parent | ddff9577fc0b204d7beb65eac523723a18c33623 (diff) | |
[jira] improve the menu list
Diffstat (limited to 'jira-widget/README.md')
| -rw-r--r-- | jira-widget/README.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/jira-widget/README.md b/jira-widget/README.md index 04c7a2e..8de9fdf 100644 --- a/jira-widget/README.md +++ b/jira-widget/README.md @@ -1,8 +1,10 @@ # Jira widget -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. +The widget shows the number of tickets assigned to the user (or any other result of a JQL query, see customization section) and when clicked shows them in the list, grouped by the ticket status. Left-click on the item opens the issue in the default browser: - +<p align="center"> +<img alt="screenshot" src="https://raw.githubusercontent.com/streetturtle/awesome-wm-widgets/master/jira-widget/screenshot/screenshot.png"/> +</p> ## How it works @@ -19,7 +21,7 @@ It is possible to customize widget by providing a table with all or some of the | `host` | Required | Ex: _http://jira.tmnt.com_ | | `query` | `jql=assignee=currentuser() AND resolution=Unresolved` | JQL query | | `icon` | `~/.config/awesome/awesome-wm-widgets/jira-widget/jira-mark-gradient-blue.svg` | Path to the icon | -| `timeout` | 10 | How often in seconds the widget refreshes | +| `timeout` | 600 | How often in seconds the widget refreshes | ## Installation @@ -36,13 +38,13 @@ Then change file's permissions to 600 (so only you can read/write it): ```bash chmod 600 ~/.netrc ``` -And test if it works by calling the API: +And test if it works by calling the API (`-n` option is to use the .netrc file for authentication): ```bash -curl -s -n 'https://turtleninja.com/rest/api/2/search?jql=assignee=currentuser()+AND+resolution=Unresolved' +curl -n 'https://turtleninja.com/rest/api/2/search?jql=assignee=currentuser()+AND+resolution=Unresolved' ``` -Clone/download repo and use widget in **rc.lua**: +Clone/download repo and use the widget in **rc.lua**: ```lua local jira_widget = require("awesome-wm-widgets.jira-widget.jira") |