From 7ea3eec17924a814ec3109958ba9d2db50e87ffd Mon Sep 17 00:00:00 2001 From: streetturtle Date: Mon, 12 Apr 2021 20:53:44 -0400 Subject: [jira] improve the menu list --- jira-widget/README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'jira-widget/README.md') 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: -![git](./out.gif) +

+screenshot +

## 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") -- cgit v1.2.3