https://github.com/glauedson/github-readme-educational-badge

A customizable GitHub profile badge that displays your university, course, and degree type. Show your academic journey directly in your README and connect with other developers who share similar paths.
https://github.com/glauedson/github-readme-educational-badge

academic badge course degree education github-badge profile readme student university

Last synced: 29 days ago
JSON representation

A customizable GitHub profile badge that displays your university, course, and degree type. Show your academic journey directly in your README and connect with other developers who share similar paths.

• Host: GitHub
• URL: https://github.com/glauedson/github-readme-educational-badge
• Owner: Glauedson
• License: mit
• Created: 2025-09-05T13:23:55.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2025-09-06T14:37:58.000Z (about 1 month ago)
• Last Synced: 2025-09-06T16:25:25.411Z (about 1 month ago)
• Topics: academic, badge, course, degree, education, github-badge, profile, readme, student, university
• Language: JavaScript
• Homepage: https://github-readme-educational-badge.vercel.app
• Size: 46.9 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          





### 🎓 GitHub Readme Educational Badge  

Show your **current education** in your GitHub profile README!  

Display your **university/college**, **course**, **degree type**, **progress percentage**, and even the **institution image/logo**.  



## 🚀 Quick Setup  

1. Copy-paste the markdown snippet below into your GitHub profile README.  

2. Replace the query parameters with your own information:  

```md

![badge](https://github-readme-educational-badge.vercel.app/badge?name=Harvard%20University&course=Computer%20Science&degree=Master&progress=90%25&img=https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ9GQ7Ku6uEiT0B0nzcP1fqZT4XoDQiir4PRw&s)

```



### Response:

![badge](https://github-readme-educational-badge.vercel.app/badge?name=Harvard%20University&course=Computer%20Science&degree=Master&progress=90%25&img=https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQ9GQ7Ku6uEiT0B0nzcP1fqZT4XoDQiir4PRw&s)



3. Star the repo :)

## 🔑 Parameters  

| Parameter   | Description |

|-------------|-------------|

| `name`      | Institution name ( e.g., *Harvad* ) |

| `course`    | Course/Program ( e.g., *software engineering* ) |

| `degree`    | Degree type ( e.g., *Bachelor*, *Master*, *PhD* ) |

| `progress`  | Percentage of completion ( e.g., *85%25* ) |

| `img`       | Link to institution logo or image |

## ⭐ Contribute

- Star the repo if you like it!

- Open an issue for bugs or feature requests.

- Pull requests are welcome to improve the badge design or add new features.