Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shreyash3087 authored Nov 10, 2024
1 parent f5b0024 commit 10665df
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,44 @@ https://gssoc.girlscript.tech/leaderboard?year=<YEAR_BADGES>&username=<GITHUB_US
<img src=https://raw.githubusercontent.com/GSSoC24/Postman-Challenge/main/docs/assets/Postman%20Dark.png" width="100px" height="100px" />
```
# GSSoC Dynamic Badges
In Addition to the Manual Method You can Display your GSSoC (GirlScript Summer of Code) badges directly on your GitHub profile with dynamically generated badges!
![GSSoC-Badges](https://gssoc-dymanic-badges.vercel.app/api/shubhagarwal1?year=2024Extd)
## ✨ Features
- **Real-Time Updates**: Badges are updated with live leaderboard data from GSSoC, reflecting your current progress.
- **Milestone-Based Badges**: Unlock badges based on your score, each representing a new achievement level.
- **Customizable for Profile**: Show your badge on your GitHub profile in a way that’s easy to set up.
## 🚀 How to Use
### Step 1: Get Your Badge URL
Replace `<username>` with your GitHub username and `<year>` with the GSSoC year (e.g., `2024Extd`) in the URL below:
```plaintext
https://gssoc-dymanic-badges.vercel.app/api/<username>?year=<year>
```

### Step 2: Embed the Badge in Your GitHub Profile
Add the generated badge to your GitHub profile using Markdown. Here’s how:
```plaintext
![GSSoC-Badges](https://gssoc-dymanic-badges.vercel.app/api/<username>?year=<year>)
```
Example:
```plaintext
![GSSoC-Badges](https://gssoc-dymanic-badges.vercel.app/api/shubhagarwal1?year=2024Extd)
```
### Optional: Make the Badge Redirect to GSSoC's Website
To link the badge to the GSSoC website or leaderboard, wrap the Markdown in a link:
```plaintext
[![GSSoC-Badges](https://gssoc-dymanic-badges.vercel.app/api/<username>?year=<year>)](https://gssoc.girlscript.tech)
```

### Thankyou

#### Thank you for participating and contributing to our learning community! 🙌

Expand Down

0 comments on commit 10665df

Please sign in to comment.