Github Readme Streak Stats is a dynamic badge generator that displays GitHub contribution streaks on user profile READMEs.
The tool solves the problem of visualizing contribution consistency by fetching GitHub contribution data and rendering it as a customizable SVG card showing total contributions, current streak length, and longest streak. Users embed the generated badge in their profile README through either a web-hosted endpoint or by generating a static SVG via GitHub Actions. The GitHub Actions approach allows users to store generated stats in their repository, eliminating dependency on external hosting and enabling access to private contribution data through personal access tokens.
The tool suits developers who want to showcase their contribution habits on their GitHub profiles. It offers two deployment paths: a quick setup using the public web service, or self-hosting for better reliability. The README recommends self-hosting for improved dependability. The GitHub Actions option is particularly valuable for users with private repositories or those seeking independence from external services. Customization options are available through configurable parameters, viewable on the demo site.
Development activity shows consistent engagement with user requests and bug fixes. The project maintains active support through a dedicated Discord server for discussions and assistance. The codebase accepts contributions and has participated in community-driven development initiatives. The tool has achieved significant adoption, with many users embedding it across GitHub profiles.
