github-readme-streak-stats

GitHub Readme Streak Stats is a tool that generates a small image badge you can embed in your GitHub profile page. The badge shows three numbers: your total contributions to GitHub, your current consecutive-day contribution streak, and the longest streak you have ever maintained. It is designed to go in the README file that GitHub displays at the top of your profile when someone visits it.

Setup takes one step: paste a line of markdown into your profile README with your GitHub username, and the badge appears automatically. The image is generated on demand by a hosted service, so you do not need to run anything yourself. For people who want more control, the project can also be deployed to your own server on platforms like Heroku or Vercel.

The appearance of the badge is highly customizable through URL parameters. You can pick from a set of pre-built color themes, or set individual colors for the background, border, numbers, labels, and other elements. The card dimensions, corner radius, and whether to show or hide each of the three sections can all be adjusted. There is also support for displaying the dates in different formats, showing numbers in short form like 1.5k instead of 1,500, and excluding specific days of the week from streak counting, which is useful if you do not work on weekends.

The output can be an SVG image, a PNG, or raw JSON if you want to use the data in another way. Streak counting can be set to daily mode, where you need to contribute every day, or weekly mode, where one contribution per week counts.

The project is written in PHP and is MIT licensed. It is one of the more popular GitHub profile decoration tools and has been added to a large number of developer profiles. The full README is longer than what was shown.