github-contributions-widget/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Github Contributions Widget

Shows the contribution graph, similar to the one on the github profile page:

![screenshot](./screenshot.jpg)

## Customization

It is possible to customize the widget by providing a table with all or some of the following config parameters:

| Name | Default | Description |
|---|---|---|
| `username` | 'streetturtle' | Username |
| `days` | `365` | Number of days in the past, more days - wider the widget |
| `empty_color` | `beautiful.bg_normal` | Color of the days with no contributions |
| `with_border` | `true` | Should the graph contains border or not |
| `margin_top` | `1` | Top margin |

Few more screenshots:

1000 days, with border:  
![screenshot1](./screenshot1.jpg)

365 days, no border:  
![screenshot2](./screenshot2.jpg)


## Installation

Clone/download repo under **~/.config/awesome** and use widget in **rc.lua**:

```lua
local github_contributions_widget = require("awesome-wm-widgets.github-contributions-widget.github-contributions-widget")
...
s.mytasklist, -- Middle widget
	{ -- Right widgets
    	layout = wibox.layout.fixed.horizontal,
		...
		-- default
        github_contributions_widget({username = '<your username>'}),
		...
```