From ee008b6e5478eba7714846b49fc2141b770bdd6b Mon Sep 17 00:00:00 2001 From: streetturtle Date: Mon, 9 Nov 2020 10:07:14 -0500 Subject: [github-contribution] add themes --- github-contributions-widget/README.md | 37 +++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) (limited to 'github-contributions-widget/README.md') diff --git a/github-contributions-widget/README.md b/github-contributions-widget/README.md index b7f6b93..7d02008 100644 --- a/github-contributions-widget/README.md +++ b/github-contributions-widget/README.md @@ -1,8 +1,12 @@ # Github Contributions Widget -Shows the contribution graph, similar to the one on the github profile page: +The widget is inspired by the https://github-contributions.now.sh/ and relies on it's API. -![screenshot](./screenshot.jpg) +It shows the contribution graph, similar to the one on the github profile page: ![screenshot](./screenshots/screenshot.jpg) + +You might wonder what could be the reason to have your github's contributions in front of you all day long? The more you contribute, the nicer widget looks! Check out [Thomashighbaugh](https://github.com/Thomashighbaugh)'s graph: + +![](./screenshots/Thomashighbaugh.png) ## Customization @@ -10,20 +14,37 @@ It is possible to customize the widget by providing a table with all or some of | Name | Default | Description | |---|---|---| -| `username` | 'streetturtle' | Username | +| `username` | `streetturtle` | GitHub 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 | +| `color_of_empty_cells` | Theme's default | Color of the days with no contributions | | `with_border` | `true` | Should the graph contains border or not | | `margin_top` | `1` | Top margin | +| `theme` | `standard` | Color theme of the graph, see below | + +_Note:_ widget height is 21px (7 rows of 3x3 cells). So it would look nice on the wibar of 22-24px height. + +### Themes -Few more screenshots: +Following themes are available: + +| Theme name | Preview | +|---|---| +| standard | ![standard](./screenshots/standard.png) | +| classic | ![classic](./screenshots/classic.png) | +| teal | ![teal](./screenshots/teal.png) | +| leftpad | ![leftpad](./screenshots/leftpad.png) | +| dracula | ![dracula](./screenshots/dracula.png) | +| pink | ![pink](./screenshots/pink.png) | + +To add a new theme, simply add a new entry in `themes` table (themes.lua) with the colors of your theme. + +### Screenshots 1000 days, with border: -![screenshot1](./screenshot1.jpg) +![screenshot1](./screenshots/screenshot1.jpg) 365 days, no border: -![screenshot2](./screenshot2.jpg) - +![screenshot2](./screenshots/screenshot2.jpg) ## Installation -- cgit v1.2.3