You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-55Lines changed: 36 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,58 +11,14 @@ Actions.
11
11
12
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
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
-

23
-
24
-
**In Dark Mode**
25
-

26
-
27
-
## Background
14
+
## ⚠️ Disclaimer
28
15
29
-
When someone views a profile on GitHub, it is often because they are curious
30
-
about a user's open source projects and contributions. Unfortunately, that
31
-
user's stars, forks, and pinned repositories do not necessarily reflect the
32
-
contributions they make to private repositories. The data likewise does not
33
-
present a complete picture of the user's total contributions beyond the current
34
-
year.
35
-
36
-
This project aims to collect a variety of profile and repository statistics
37
-
using the GitHub API. It then generates images that can be displayed in
@@ -72,32 +28,57 @@ caches statistics for your repositories. For more information, see issue
72
28
Personal access token must have permissions: `read:user` and `repo`. Copy
73
29
the access token when it is generated – if you lose it, you will have to
74
30
regenerate the token.
75
-
2. Click [here](https://github.com/jstrieb/github-stats/generate) to create a
31
+
32
+
2. Click [here](https://github.com/rahul-jha98/github-stats-transparent/fork) to create a
76
33
fork of this repository
34
+
77
35
3. If this is the README of your fork, click [this
78
36
link](../../settings/secrets/actions) to go to the "Secrets" page.
79
37
Otherwise, go to the "Settings" tab of the newly-created repository and go
80
38
to the "Secrets" page (bottom left).
39
+
81
40
4. Create a new secret with the name `ACCESS_TOKEN` and paste the copied
82
41
personal access token as the value.
42
+
83
43
5. If you want to ignore certain repos, add them (separated by commas) to a new
84
-
secret—created as before—called `EXCLUDED`. If you want to ignore certain
85
-
languages, add them (separated by commas) to a new secret called
44
+
secret—created as before—called `EXCLUDED`.
45
+
46
+
6. If you want to ignore certain languages, add them (separated by commas) to a new secret called
86
47
`EXCLUDED_LANGS`.
48
+
87
49
6. Go to the [Actions
88
50
Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run
89
51
Workflow" on the right side of the screen to generate images for the first
90
52
time. The images will be periodically generated every hour, but they can be
91
53
manually regenerated by manually running the workflow.
92
-
7. Check out the images that have been created in the [`generated`](generated)
93
-
folder.
54
+
55
+
7. Check out the images that have been created in the [`generated`](../output/generated)
56
+
folder in output branch.
57
+
94
58
8. Link back to this repository so that others can generate their own
95
59
statistics images.
60
+
96
61
9. Star this repo if you like it!
97
62
98
63
99
-
# Related Projects
64
+
<br>
65
+
<br>
66
+
67
+
## 🤔 Why Transparent ??
68
+
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.
69
+
70
+
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.
71
+
72
+
After wasting a day playing with different color values finally settled on one. Hope you like it.
0 commit comments