Skip to content

Commit e7ada20

Browse files
committed
add images for light and dark mode in README
1 parent 2818da3 commit e7ada20

File tree

5 files changed

+19
-345
lines changed

5 files changed

+19
-345
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
# [GitHub Stats Visualization](https://github.com/jstrieb/github-stats)
1+
# GitHub Stats Visualizations : Transparent
2+
> Generate visualizations of GitHub user and repository statistics using GitHub
3+
Actions.
24

3-
<a href="https://github.com/jstrieb/github-stats">
5+
<a href="https://github.com/rahul-jha98/github-stats-transparent">
46

5-
![](https://github.com/jstrieb/github-stats/blob/master/generated/overview.svg)
6-
![](https://github.com/jstrieb/github-stats/blob/master/generated/languages.svg)
7+
![](https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/output/generated/overview.svg)
8+
![](https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/output/generated/languages.svg)
79

810
</a>
911

10-
Generate visualizations of GitHub user and repository statistics using GitHub
11-
Actions.
12+
> NOTE: This repository is my extension of the repo [jstrieb/github-stats](https://github.com/jstrieb/github-stats). This repo was meant to serve as a detached fork of his project. If you like this repository make sure you also star his repository to show appreciation for his work.
13+
14+
## Why Transparent
15+
With the introduction of dark mode in Github it has become difficult to set an image background that looks consistent with the background in both dark and light mode.
16+
17+
To solve this the most obvious solution was to make the background transparent. All that was left was to choose colors for text that makes it legible in light as well as dark background.
18+
19+
After wasting a day playing with different color values finally settled on one. Hope you like it.
20+
21+
**In Light Mode**
22+
![](./readme_images/light.png)
1223

13-
This project is currently a work-in-progress; there will always be more
14-
interesting stats to display.
24+
**In Dark Mode**
25+
![](./readme_images/dark.png)
1526

1627
## Background
1728

generated/languages.svg

Lines changed: 0 additions & 238 deletions
This file was deleted.

generated/overview.svg

Lines changed: 0 additions & 99 deletions
This file was deleted.

readme_images/dark.png

38.5 KB
Loading

readme_images/light.png

37.5 KB
Loading

0 commit comments

Comments
 (0)