2020-07-13 17:26:59 +08:00
< p align = "center" >
2020-07-15 05:08:52 +08:00
< h2 align = "center" > GitHub Readme Stats< / h2 >
2020-07-13 17:26:59 +08:00
< p align = "center" > Get dynamically generated GitHub stats on your readmes!< / p >
2020-07-16 16:32:15 +08:00
< / p >
2020-07-13 17:26:59 +08:00
< p align = "center" >
< a href = "https://github.com/anuraghazra/github-readme-stats/actions" >
< img alt = "Tests Passing" src = "https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" / >
< / a >
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" >
< img alt = "Issues" src = "https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" / >
< / a >
< a href = "https://github.com/anuraghazra/github-readme-stats/pulls" >
< img alt = "GitHub pull requests" src = "https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" / >
< / a >
< / p >
< p align = "center" >
< a href = "#demo" > View Demo< / a >
·
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" > Report Bug< / a >
·
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" > Request Feature< / a >
< / p >
< / p >
2020-07-16 16:32:15 +08:00
< p align = "center" > Loved the project? Please consider < a href = "https://www.paypal.me/anuraghazra" > donating< / a > to help it improve!
2020-07-09 18:38:21 +08:00
2020-07-10 01:26:57 +08:00
# Features
2020-07-15 05:08:52 +08:00
- [GitHub Stats Card ](#github-stats-card )
- [GitHub Extra Pins ](#github-extra-pins )
2020-07-12 15:46:30 +08:00
- [Customization ](#customization )
2020-07-11 17:03:29 +08:00
- [Deploy Yourself ](#deploy-on-your-own-vercel-instance )
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
# GitHub Stats Card
2020-07-09 18:38:21 +08:00
2020-07-10 18:45:03 +08:00
Copy paste this into your markdown content, and that's it. Simple!
2020-07-09 18:38:21 +08:00
2020-07-15 05:08:52 +08:00
Change the `?username=` value to your GitHub's username.
2020-07-09 18:38:21 +08:00
2020-07-10 18:49:52 +08:00
```md
[](https://github.com/anuraghazra/github-readme-stats)
```
2020-07-15 05:08:52 +08:00
_Note: Ranks are calculated based on user's stats, see [src/calculateRank.js ](./src/calculateRank.js )_
2020-07-13 22:20:43 +08:00
2020-07-10 18:45:03 +08:00
### Hiding individual stats
2020-07-09 20:20:15 +08:00
2020-07-15 05:08:52 +08:00
To hide any specific stats, you can pass a query parameter `?hide=` with an array of items you wanna hide.
2020-07-09 20:20:15 +08:00
> Options: `&hide=["stars","prs","issues","contribs"]`
```md
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"] )
```
2020-07-09 21:16:41 +08:00
### Showing icons
2020-07-15 05:08:52 +08:00
To enable icons, you can pass `show_icons=true` in the query param, like so:
2020-07-09 21:16:41 +08:00
```md
```
2020-07-09 23:04:10 +08:00
Other options:
2020-07-15 05:08:52 +08:00
- `&hide_border=true` hide the border box if you don't like it :D
- `&line_height=30` control the line-height between text
2020-07-13 22:20:43 +08:00
- `&hide_rank=true` hides the ranking
2020-07-09 23:04:10 +08:00
2020-07-12 15:46:30 +08:00
### Customization
2020-07-15 05:08:52 +08:00
You can customize the appearance of your `Stats Card` or `Repo Card` however you want with URL params.
2020-07-12 15:46:30 +08:00
Customization Options:
| Option | type | Stats Card (default) | Repo Card (default) |
| ----------- | --------- | ---------------------- | ---------------------- |
| title_color | hex color | #2f80ed | #2f80ed |
| text_color | hex color | #333 | #333 |
| icon_color | hex color | #4c71f2 | #586069 |
| bg_color | hex color | rgba(255, 255, 255, 0) | rgba(255, 255, 255, 0) |
2020-07-16 20:33:33 +08:00
| show_owner | boolean | not applicable | false |
2020-07-12 15:46:30 +08:00
- You can also customize the cards to be compatible with dark mode
```md
2020-07-12 16:48:25 +08:00
2020-07-12 15:46:30 +08:00
```
2020-07-10 01:26:57 +08:00
### Demo
2020-07-09 18:38:21 +08:00
2020-07-09 21:16:41 +08:00
- Default
2020-07-09 18:38:21 +08:00
2020-07-09 20:20:15 +08:00
- Hiding specific stats
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"] )
2020-07-09 21:16:41 +08:00
- Showing icons
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true )
2020-07-12 15:46:30 +08:00
- Customizing stats card
2020-07-12 16:34:02 +08:00
2020-07-12 15:46:30 +08:00
- Customizing repo card
2020-07-12 16:34:02 +08:00
2020-07-12 15:46:30 +08:00
2020-07-15 05:08:52 +08:00
# GitHub Extra Pins
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
Yey! You are no longer limited to 6 pinned repositories.
2020-07-10 01:26:57 +08:00
### Usage
2020-07-10 18:45:03 +08:00
Copy-paste this code into your readme and change the links.
2020-07-10 01:26:57 +08:00
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
```md
2020-07-10 14:02:59 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
```
### Demo
2020-07-10 14:02:59 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
2020-07-16 20:33:33 +08:00
Use [show_owner ](#customization ) variable to include the repo's owner username
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
### Quick Tip (Align The Repo Cards)
2020-07-15 05:08:52 +08:00
You usually won't be able to layout the images side by side. To do that you can use this approach:
2020-07-10 01:26:57 +08:00
```md
< a href = "https://github.com/anuraghazra/github-readme-stats" >
2020-07-10 14:02:59 +08:00
< img align = "left" src = "https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" / >
2020-07-10 01:26:57 +08:00
< / a >
< a href = "https://github.com/anuraghazra/convoychat" >
2020-07-10 14:02:59 +08:00
< img align = "left" src = "https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" / >
2020-07-10 01:26:57 +08:00
< / a >
```
2020-07-15 03:30:03 +08:00
## Deploy on your own Vercel instance
2020-07-11 17:03:29 +08:00
2020-07-15 05:08:52 +08:00
Since the GitHub API only allows 5k requests per hour, it is possible that my `https://github-readme-stats.vercel.app/api` could hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
2020-07-11 17:03:29 +08:00
2020-07-16 19:52:02 +08:00
NOTE: Since [#58 ](https://github.com/anuraghazra/github-readme-stats/pull/58 ) we should be able to handle more than 5k requests and have no issues with downtime :D
2020-07-11 17:03:29 +08:00
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
2020-07-15 05:08:52 +08:00
< details >
< summary > Guide on setting up Vercel< / summary >
2020-07-15 03:30:03 +08:00
1. Go to [vercel.com ](https://vercel.com/ )
2020-07-15 03:32:06 +08:00
1. Click on `Log in`
2020-07-16 16:32:15 +08:00
2020-07-15 03:32:06 +08:00
1. Sign in with GitHub by pressing `Continue with GitHub`
2020-07-16 16:32:15 +08:00
2020-07-15 03:30:03 +08:00
1. Sign into GitHub and allow access to all repositories, if prompted
1. Fork this repo
1. Go back to your [Vercel dashboard ](https://vercel.com/dashboard )
2020-07-15 05:08:52 +08:00
1. Select `Import Project`
2020-07-16 16:32:15 +08:00
2020-07-15 03:32:06 +08:00
1. Select `Import Git Repository`
2020-07-16 16:32:15 +08:00
2020-07-16 19:52:02 +08:00
1. Select root and keep everything as is, just add your environment variable named PAT_1 (as shown), which will contain a personal access token (PAT), which you can easily create [here ](https://github.com/settings/tokens/new ) (leave everything as is, just name it something, it can be anything you want)
2020-07-16 16:32:15 +08:00
2020-07-15 03:30:03 +08:00
1. Click deploy, and you're good to go. See your domains to use the API!
2020-07-15 05:08:52 +08:00
< / details >
2020-07-11 17:03:29 +08:00
2020-07-09 18:38:21 +08:00
Contributions are welcomed! < 3
2020-07-15 03:30:03 +08:00
Made with :heart: and JavaScript.
