diff options
Diffstat (limited to 'github-prs-widget/README.md')
| -rw-r--r-- | github-prs-widget/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
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; + + + +## 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' + }, +} +... +``` |