diff options
| author | Pavel Makhov <pmakhov@theoctavegroup.com> | 2019-11-23 21:05:16 -0500 |
|---|---|---|
| committer | Pavel Makhov <pmakhov@theoctavegroup.com> | 2019-11-23 21:05:16 -0500 |
| commit | 70867f69ff5b516cd520e3e709d2e440c20a59cd (patch) | |
| tree | fd5bc34876d71778a436dce567268e74b6c606e3 /jira-widget/README.md | |
| parent | 7478043604b763addea0127f6fec17ac6c55088a (diff) | |
Small improvements in jira widget
Diffstat (limited to 'jira-widget/README.md')
| -rw-r--r-- | jira-widget/README.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/jira-widget/README.md b/jira-widget/README.md new file mode 100644 index 0000000..c711f04 --- /dev/null +++ b/jira-widget/README.md @@ -0,0 +1,35 @@ +# 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 + +2 + +## How it works + +Widget users cURL to query JIRA's REST API. In order to be authenticated, widget uses netrc feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder. + +## Customization + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| `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 | + +## Installation + +Clone/download repo and use widget in **rc.lua**: + +```lua +local jira_widget = require("awesome-wm-widgets.jira-widget.jira") +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + -- default + jira_widget({host = 'http://jira.tmnt.com'}), + ... +``` |