johannchopin / stackoverflow-readme-profile

Easily share your Stackoverflow's profile on your README

stackoverflow-readme-profile

Easily share your Stackoverflow's profile on your README.

---

➡️ Get your profile badge:

💡 How to use?

Use the online generator for a quicker setup

You can generate your SO profile by calling this url with the corresponding template name and your SO user id:

https://stackoverflow-readme-profile.johannchopin.fr/:template/:id

Use it like that in your README:

[![johannchopin's SO profile](https://stackoverflow-readme-profile.johannchopin.fr/:template/:id)](https://github.com/johannchopin/stackoverflow-readme-profile)

---

📄 Templates

• profile
• profile-small

profile

Render a profile badge by using the profile template:

https://stackoverflow-readme-profile.johannchopin.fr/profile/:id

Params (as query strings)

param	default	description
theme	default	Theme to use. Check them out here!
website	true	Show or not the website URL (true | false)
location	true	Show or not the location (true | false)

profile-small

Render a smaller profile badge without the location and the website

Params (as query strings)

param	default	description
theme	default	Theme to use. Check them out here!

---

➡️ Get your ranking badge:

💡 How to use?

Use the online generator for a quicker setup

You can generate your SO ranking badge by calling this url with the desired technology (see the tags list) and your SO user id:

https://stackoverflow-readme-profile.johannchopin.fr/tags-league-ranking/:tagName/:id

Params (as query strings)

param	default	description
theme	default	Theme to use. Check them out here!

🦄 Contributing

All remarks are welcome so feel free to open an issue 😉 Wants to collaborate? Please read the contributing guidelines.

📄 License

AGPL-3.0