mirror of
https://github.com/reiyua/github-profile-trophy-reiyua-mirror.git
synced 2026-11-17 06:02:09 +11:00
96 lines
3 KiB
Markdown
96 lines
3 KiB
Markdown
# Github Profile Trophy
|
|
|
|
[](https://github.com/ryo-ma/github-profile-trophy/issues)
|
|
[](https://github.com/ryo-ma/github-profile-trophy/network/members)
|
|
[](https://github.com/ryo-ma/github-profile-trophy/stargazers)
|
|
[](https://github.com/ryo-ma/github-profile-trophy/)
|
|
|
|
🏆 Add dynamically generated GitHub Trophy on your readme
|
|
|
|
# Demo
|
|
|
|
<img width="667" src="https://user-images.githubusercontent.com/6661165/91206530-4766d200-e742-11ea-961a-253e9f84c1c0.png">
|
|
|
|
|
|
# Quick Start
|
|
|
|
Add following code to your readme.
|
|
Change the `?username=` value to your GitHub's username.
|
|
|
|
```
|
|
[](https://github.com/ryo-ma/github-profile-trophy)
|
|
```
|
|
|
|
# About Rank
|
|
|
|
Ranks are `SSS` `SS` `S` `AAA` `AA` `A` `B` `C` `UNKNOWN` `SECRET`.
|
|
|
|
| Rank | Description |
|
|
| ---- | ---- |
|
|
| SSS, SS, S | You are hard to reach rank. You can brag. |
|
|
| AAA, AA, A | You can reach it if you do your best. Let's aim here first. |
|
|
| B, C | You are a growing process. |
|
|
| UNKOWN | You have not yet taken action. Let's act first. |
|
|
| SECRET | The rank is very rare. The trophy will not be displayed until the conditions are met. |
|
|
|
|
# Optional Request Parameters
|
|
|
|
* [title](#filter-by-titles)
|
|
* [rank](#filter-by-ranks)
|
|
* [column](#specify-the-maximum-row--column-size)
|
|
* [row](#specify-the-maximum-row--column-size)
|
|
|
|
## Filter by titles
|
|
|
|
You can filter the display by specifying the titles of trophy.
|
|
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Follower
|
|
```
|
|
|
|
<img width="110" src="https://user-images.githubusercontent.com/6661165/91331077-45197c00-e805-11ea-85fc-37785abee37c.png">
|
|
|
|
If You want to specify multiple titles.
|
|
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&title=Star,Follower
|
|
```
|
|
|
|
## Filter by ranks
|
|
|
|
You can filter the display by specifying the ranks.
|
|
`Available values: SECRET SSS SS S AAA AA A B C`
|
|
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S
|
|
```
|
|
|
|
<img width="110" src="https://user-images.githubusercontent.com/6661165/91327681-d20e0680-e800-11ea-8b59-bdd6a64076a2.png">
|
|
|
|
If You want to specify multiple ranks.
|
|
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&rank=S,AAA
|
|
```
|
|
|
|
|
|
## Specify the maximum row & column size
|
|
|
|
You can specify the maximum row and column size.
|
|
|
|
Restrict only row
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2
|
|
```
|
|
|
|
Restrict only column
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&column=2
|
|
```
|
|
|
|
Restrict row & column
|
|
```
|
|
https://github-profile-trophy.vercel.app/?username=ryo-ma&row=2&column=2
|
|
```
|
|
|
|
<img width="220" src="https://user-images.githubusercontent.com/6661165/91328030-48126d80-e801-11ea-8547-d2633de85b75.png">
|