Show your current education in your GitHub profile README!
Display your university/college, course, degree type, progress percentage, and even the institution image/logo.
🌍 Now with multi-language support! Available in Portuguese and English, with more languages coming soon.
- Copy-paste the markdown snippet below into your GitHub profile README.
- Replace the query parameters with your own information:
[](https://github.com/Glauedson/github-readme-educational-badge)[](https://github.com/Glauedson/github-readme-educational-badge)
- Star the repo :)
| Language | Code | Example URL |
|---|---|---|
| English | en |
/en/badge?name=... |
| Portuguese | pt |
/pt/badge?name=... |
Note
If no language is specified, English will be used by default. Example: /badge?name=... = /en/badge?name=...
| Parameter | Description | Required |
|---|---|---|
name |
Institution name ( e.g., Harvard University ) | ✅ |
course |
Course/Program ( e.g., Computer Science ) | ✅ |
degree |
Degree type ( e.g., Bachelor, Master, PhD ) | ✅ |
progress |
Percentage of completion ( e.g., 85 - without % symbol ) | ✅ |
img |
Link to institution logo or image | ❌ |
GET /{language}/badge
GET /badge # defaults to English
Query Parameters: All parameters listed in the table above.
GET /
Returns information about supported languages and example usage.
We welcome contributions for new language translations! Currently supported:
- 🇺🇸 English (en)
- 🇧🇷 Portuguese (pt)
Want to add your language? Check out our CONTRIBUTING.md guide for detailed instructions on how to add translations.
- 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.
- Help us translate the badge to more languages! See CONTRIBUTING.md
# Clone the repository
git clone https://github.com/Glauedson/github-readme-educational-badge.git
# Install dependencies
npm install
# Start development server
npm run devThis project is licensed under the MIT License.
For any questions or suggestions, feel free to reach out:
- Name: Glauedson Carlos Rodrigues
- Email: glauedson18s@gmail.com
- LinkedIn: Glauedson Carlos