summaryrefslogtreecommitdiff
path: root/gerrit-widget/README.md
diff options
context:
space:
mode:
authorPavel Makhov <pmakhov@theoctavegroup.com>2019-11-23 21:54:52 -0500
committerPavel Makhov <pmakhov@theoctavegroup.com>2019-11-23 21:54:52 -0500
commit344fd7923fc71e96e0ad31e92a7fe218b4395a0b (patch)
tree5d619e66346b047cfee1db41c2fcba71539d9d45 /gerrit-widget/README.md
parent70867f69ff5b516cd520e3e709d2e440c20a59cd (diff)
Add screenshots to gerrit widget
Diffstat (limited to 'gerrit-widget/README.md')
-rw-r--r--gerrit-widget/README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/gerrit-widget/README.md b/gerrit-widget/README.md
index c9b603b..61231d4 100644
--- a/gerrit-widget/README.md
+++ b/gerrit-widget/README.md
@@ -1,6 +1,16 @@
# Gerrit widget
-This widget adds support for [Gerrit](https://www.gerritcodereview.com/). It shows number of currently assigned reviews to the user and shows a notification when new review is assigned.
+This widget adds support for [Gerrit](https://www.gerritcodereview.com/). It shows number of currently assigned reviews to the user (by default)
+
+ ![gerrit_widget](./gerrit_widget.png)
+
+ when clicked it shows the reviews in a list, if item of a list is clicked, the review will be opened in the default browser:
+
+ ![popup](./popup.png)
+
+ Also, if a new review is assigned to the user, there will be a pop-up:
+
+ ![new_review](./new_review.png)
## Customization
@@ -8,7 +18,7 @@ It is possible to customize widget by providing a table with all or some of the
| Name | Default | Description |
|---|---|---|
-| `icon`| `/.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg| Path to the icon|
+| `icon`| `/.config/awesome/awesome-wm-widgets/gerrit-widget/gerrit_icon.svg`| Path to the icon |
| `host` | Required | Ex https://gerrit.tmnt.com |
| `query` | `is:reviewer AND status:open AND NOT is:wip` | Query to retrieve reviews |