🏆 Add dynamically generated GitHub Stat Trophies on your readme
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Go to file
ryo-ma aee3c6ad91
Add test.ts
4 years ago
.github Update FUNDING.yml 4 years ago
src Fix font size 4 years ago
test Add test.ts 4 years ago
.gitignore first commit 4 years ago
.vercelignore Add .vercelignore 4 years ago
LICENSE Add LICENSE 4 years ago
README.md Update README.md 4 years ago
debug.ts Add .vercelignore 4 years ago
deps.ts Add vercel.json 4 years ago
index.ts Add user not found error 4 years ago
vercel.json Add vercel.json 4 years ago

README.md

Github Profile Trophy

🏆 Add dynamically generated GitHub Trophy on your readme

Demo

Quick Start

Add following code to your readme.
Change the ?username= value to your GitHub's username.

[![trophy](https://github-profile-trophy.vercel.app/?username=ryo-ma)](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

  1. Title name of aggregation target.
  2. Current Rank.
  3. Title according to rank.
  4. Target aggregation result.
  5. 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.
Available value: number
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