Essential tools to spice up your GitHub Profile READMEs!
This API is currently in BETA. We're constantly adding new features to make it easier for you to make ๐ฅ GitHub READMEs! I would really appreciate it if you give us a โญ so this README can become awesome too ๐
- README View Counter - Documentation
- More coming soon!
Add the code below to your Profile README. Replace YOUR_USERNAME
with your GitHub username. Now your GitHub Profile Views will automatically increment every time someone views your profile. Unfortunately, we cannot differentiate unique views yet :(
![](https://api.ghprofile.me/view?username=YOUR_USERNAME)
Add the code below to your Repository README. Replace YOUR_USERNAME
with your GitHub username, then replace YOUR_REPOSITORY_NAME
with your GitHub repository name! Now your GitHub Profile Views will automatically increment every time someone views your profile. Unfortunately, we cannot differentiate unique views yet :(
![](https://api.ghprofile.me/view?username=YOUR_USERNAME-YOUR_REPOSITORY_NAME&label=repository%20view%20count)
Customize your counter image by adding the URLs of the desired styles and colors you want to the end of your counter URL!
![](https://api.ghprofile.me/view?username=trustedmercury-ghprofile.me&style=YOUR_STYLE)
![](https://api.ghprofile.me/view?username=YOUR_USERNAME&color=YOUR_COLOR)
Colours can be -
- CSS Named Colours (
red
,green
,blue
) - Hex Codes (
FF0000
,00FF00
,0000FF
)
![](https://api.ghprofile.me/view?username=YOUR_USERNAME&label=YOUR_CUSTOM_TEXT_HERE)
- Intuitive web dashboard for statistics and configuration