diff options
| author | streetturtle <streetturtle@gmail.com> | 2020-09-17 22:52:25 -0400 |
|---|---|---|
| committer | streetturtle <streetturtle@gmail.com> | 2020-09-17 22:52:25 -0400 |
| commit | ccb8c429da9720a45ef143ed7e4c05e6151c4e09 (patch) | |
| tree | f2edd3f3a6fe8279463c7401e83c0f7235a194eb /github-contributions-widget/README.md | |
| parent | baa96ad7da6b76b8a9d31749d66d3b05af9ba6b8 (diff) | |
new widget - github contributions
Diffstat (limited to 'github-contributions-widget/README.md')
| -rw-r--r-- | github-contributions-widget/README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/github-contributions-widget/README.md b/github-contributions-widget/README.md new file mode 100644 index 0000000..328b22e --- /dev/null +++ b/github-contributions-widget/README.md @@ -0,0 +1,42 @@ +# Github Contributions Widget + +Shows the contribution graph, similar to the one on the github profile page: + + + +## 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: + + +No borders: + + + +## 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>'}), + ... +``` |