Skip to content

Commit f992596

Browse files
committed
modified README Instructions
1 parent e7ada20 commit f992596

File tree

1 file changed

+36
-55
lines changed

1 file changed

+36
-55
lines changed

README.md

Lines changed: 36 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -11,58 +11,14 @@ Actions.
1111

1212
> 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.
1313
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)
23-
24-
**In Dark Mode**
25-
![](./readme_images/dark.png)
26-
27-
## Background
14+
## ⚠️ Disclaimer
2815

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
38-
repository READMEs, or in a user's [Profile
39-
README](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).
40-
41-
Since the project runs on GitHub Actions, no server is required to regularly
42-
regenerate the images with updated statistics. Likewise, since the user runs
43-
the analysis code themselves via GitHub Actions, they can use their GitHub
44-
access token to collect statistics on private repositories that an external
45-
service would be unable to access.
46-
47-
## Disclaimer
48-
49-
If the project is used with an access token that has sufficient permissions to
50-
read private repositories, it may leak details about those repositories in
51-
error messages. For example, the `aiohttp` library—used for asynchronous API
52-
requests—may include the requested URL in exceptions, which can leak the name
53-
of private repositories. If there is an exception caused by `aiohttp`, this
54-
exception will be viewable in the Actions tab of the repository fork, and
16+
The project uses access token that has read access to private repositories and if there is any
17+
exception while reading data from any repository it throws Exception which is printed in the workflow logs.
18+
This exception will be viewable in the Actions tab of the repository fork, and
5519
anyone may be able to see the name of one or more private repositories.
5620

57-
Due to some issues with the GitHub statistics API, there are some situations
58-
where it returns inaccurate results. Specifically, the repository view count
59-
statistics and total lines of code modified are probably somewhat inaccurate.
60-
Unexpectedly, these values will become more accurate over time as GitHub
61-
caches statistics for your repositories. For more information, see issue
62-
[#2](https://github.com/jstrieb/github-stats/issues/2) and
63-
[#3](https://github.com/jstrieb/github-stats/issues/3).
64-
65-
# Installation
21+
## ⚙️ Installation
6622

6723
<!-- TODO: Add details and screenshots -->
6824

@@ -72,32 +28,57 @@ caches statistics for your repositories. For more information, see issue
7228
Personal access token must have permissions: `read:user` and `repo`. Copy
7329
the access token when it is generated – if you lose it, you will have to
7430
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
7633
fork of this repository
34+
7735
3. If this is the README of your fork, click [this
7836
link](../../settings/secrets/actions) to go to the "Secrets" page.
7937
Otherwise, go to the "Settings" tab of the newly-created repository and go
8038
to the "Secrets" page (bottom left).
39+
8140
4. Create a new secret with the name `ACCESS_TOKEN` and paste the copied
8241
personal access token as the value.
42+
8343
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
8647
`EXCLUDED_LANGS`.
48+
8749
6. Go to the [Actions
8850
Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run
8951
Workflow" on the right side of the screen to generate images for the first
9052
time. The images will be periodically generated every hour, but they can be
9153
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+
9458
8. Link back to this repository so that others can generate their own
9559
statistics images.
60+
9661
9. Star this repo if you like it!
9762

9863

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.
73+
74+
![](https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/light.png)
75+
76+
![](https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/dark.png)
77+
78+
79+
## Related Projects
10080

81+
- Extension of a detached fork of [jstrieb/github-stats](https://github.com/jstrieb/github-stats)
10182
- Inspired by a desire to improve upon
10283
[anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
10384
- Makes use of [GitHub Octicons](https://primer.style/octicons/) to precisely

0 commit comments

Comments
 (0)