Skip to content

Commit cfd10d0

Browse files
committed
included screenshots in README
1 parent be25244 commit cfd10d0

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,29 @@ anyone may be able to see the name of one or more private repositories.
3737
Otherwise, go to the "Settings" tab of the newly-created repository and go
3838
to the "Secrets" page (bottom left).
3939

40+
![](https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/Actions.png')
41+
4042
4. Create a new secret with the name `ACCESS_TOKEN` and paste the copied
4143
personal access token as the value.
4244

45+
<img src='https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/Token.png' height='250px'/>
46+
4347
5. If you want to ignore certain repos, add them (separated by commas) to a new
4448
secret—created as before—called `EXCLUDED`.
4549

50+
<img src='https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/Exclude.png' height='250px'/>
51+
4652
6. If you want to ignore certain languages, add them (separated by commas) to a new secret called
4753
`EXCLUDED_LANGS`.
4854

49-
7.
55+
7. By default the languages, stars, forks and repository views do not consider stats from
56+
public repositories that you have forked and contributed to. But if you want to count stats from
57+
forked repositories also you can do so by creating a new secret called `COUNT_STATS_FROM_FORKS`.
58+
For the value you can put any random value because the action only checks if the secret is set or not.
59+
60+
<img src='https://raw.githubusercontent.com/rahul-jha98/github-stats-transparent/main/readme_images/Forks.png' height='250px'/>
5061

51-
8. Go to the [Actions
52-
Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run
62+
8. Go to the [Actions Page](../../actions?query=workflow%3A"Generate+Stats+Images") and press "Run
5363
Workflow" on the right side of the screen to generate images for the first
5464
time. The images will be periodically generated every hour, but they can be
5565
manually regenerated by manually running the workflow.

0 commit comments

Comments
 (0)