Add dynamically generated GitHub Trophy on your readme
Github Profile Trophy
🏆 Add dynamically generated GitHub Trophy on your readme
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 the rank. You can brag. |
| AAA, AA, A | You can reach the rank 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. |
Secret Rank
The acquisition condition is secret, but you can know the condition by reading this code.
There are still few secret trophies.
Therefore, if you come up with interesting conditions, I am waiting for contributions.
About Display details
- Title name of aggregation target.
- Current Rank.
- Title according to rank.
- Target aggregation result.
- Next Rank Bar. The road from the current rank to the next rank.
Optional Request Parameters
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
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
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.
Trophy out of limits will not be displayed.
Available value: number type
Default: column=6 row=3
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=3
Download Details:
Author: ryo-ma
Demo: https://github-profile-trophy.vercel.app/
Source Code: https://github.com/ryo-ma/github-profile-trophy
#deno #node #nodejs #javascript
