From 0282f91feb1dd39bda6d124bc6f98c0fee0d5f28 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Sun, 19 Sep 2021 21:10:39 -0400
Subject: new github prs widget

---
 github-prs-widget/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 github-prs-widget/README.md

(limited to 'github-prs-widget/README.md')

diff --git a/github-prs-widget/README.md b/github-prs-widget/README.md
new file mode 100644
index 0000000..123a593
--- /dev/null
+++ b/github-prs-widget/README.md
@@ -0,0 +1,41 @@
+# GitHub PRs Widget
+
+<p align="center">
+  <a href="https://github.com/streetturtle/awesome-wm-widgets/labels/github-prs" target="_blank"><img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/streetturtle/awesome-wm-widgets/github-prs"></a>
+</p>
+
+The widget shows the number of pull requests assigned to the user and when clicked shows additional information, such as 
+ - author's name and avatar (opens user profile page when clicked);
+ - PR name (opens MR when clicked);
+ - name of the repository;
+ - when was created;
+ - number of comments;
+
+![screenshot](./screenshots/screenshot1.png)
+
+## Customization
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `reviewer` | Required | github user login |
+
+## Installation
+
+Install and setup [GitHub CLI](https://cli.github.com/)  
+Clone/download repo and use widget in **rc.lua**:
+
+```lua
+local github_prs_widget = require("awesome-wm-widgets.github-prs-widget")
+...
+s.mytasklist, -- Middle widget
+{ -- Right widgets
+    layout = wibox.layout.fixed.horizontal,
+    ...
+    github_prs_widget {
+        reviewer = 'streetturtle'
+    },
+}	
+...
+```
-- 
cgit v1.2.3