Skip to content

Commit ae35685

Browse files
Update README.md
1 parent 5570c1c commit ae35685

File tree

1 file changed

+23
-31
lines changed

1 file changed

+23
-31
lines changed

README.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,35 @@
1-
# Hacking The Github Stats
1+
# Hacking The GitHub Stats
22

3-
*`updated 28 May 2023`*
3+
*`updated July 26, 2024`*
44

55
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fhacking-the-github-stats&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com)
66

7-
The [GitHub Stats](https://github.com/anuraghazra/github-readme-stats)
8-
is an external service to display your ranking based on commits, PRs,
9-
issues etc. You just simply need the URL and change the details,
10-
include it in your GitHub profile and you're done.
7+
The [GitHub Stats](https://github.com/anuraghazra/github-readme-stats) is an
8+
external service that displays your ranking based on commits, PRs, issues,
9+
etc. You simply need the URL, change the details to refer to your account,
10+
include it in your GitHub profile, and you're done.
1111

12-
If you don't have any idea how it works, it is an external web app
13-
that uses GitHub data (through its API) to generate your rank.
14-
You don't need to install anything, you just simply get the URL
15-
of the app, change the details so that it's referring to your account
16-
and you're done.
12+
## How It Works
13+
- GitHub Stats is an external web app that uses GitHub data (through its API)
14+
to generate your rank.
15+
- No installation is required; just get the URL of the app, change the details
16+
to refer to your account, and you're done.
1717

18+
example:
1819
```
1920
https://github-readme-stats.vercel.app/api?username=[yourusername]
2021
```
21-
make sure you include your private repos, `&count_private=true`.
22-
23-
Now, in order for you to display this in your profile,
24-
if ever you don't have one, make sure you create one.
25-
Create a repository with the same name as your username.
26-
It is a special repository that will appear in your profile.
27-
28-
so mine is: `xdvrx1/xdvrx1`
29-
30-
Make sure that you initialize it with the `README.md`, if not,
31-
you should create one also.
32-
33-
Add description about you and this, of course, you must change
34-
the details:
35-
36-
```
37-
<p align="left"> <img src="https://github-readme-stats.vercel.app/api?username=[yourusername]&theme=tokyonight&show_icons=true&hide_border=true&count_private=true&include_all_commits=true" /> </p>
38-
```
39-
It's now embedded in your GitHub Profile! You can still change
40-
the settings. Refer to the details [here](https://github.com/anuraghazra/github-readme-stats).
22+
make sure you include your private repos if you enabled your own instance, `&count_private=true`.
23+
24+
## Displaying in Your Profile
25+
1. Create a repository with the same name as your username (e.g., `jdevfullstack/jdevfullstack`).
26+
This special repository will appear in your profile.
27+
2. Initialize it with a `README.md` file, or create one if it doesn't exist.
28+
3. Add a description about yourself and include the following code, replacing `[yourusername]` with your GitHub username:
29+
```html
30+
<p align="left"> <img src="https://github-readme-stats.vercel.app/api?username=[yourusername]&theme=tokyonight&show_icons=true&hide_border=true&count_private=true&include_all_commits=true" /> </p>
31+
4. The stats are now embedded in your GitHub Profile! You can still change the
32+
settings. Refer to the details [here](https://github.com/anuraghazra/github-readme-stats).
4133

4234
## App Stat Computation Breakdown
4335
This is the latest computation and the factors involved:

0 commit comments

Comments
 (0)