waka-readme-stats helps you display your development activity directly on your GitHub profile README. The action integrates with WakaTime to fetch your coding statistics and renders them as interactive progress bars and charts. You can customize what metrics you want to show, tailoring your profile to highlight your productivity and coding habits. The primary technology used is GitHub Actions for automation and WakaTime for data retrieval.
This project stands out by providing a straightforward way to visualize coding activity within a README, enhancing profile transparency. It offers extensive customization options, allowing users to select specific metrics and tailor the visual representation. The flexible configuration via workflow parameters makes it adaptable to individual preferences and needs. It also features various flags to control the displayed information, enhancing user control.
- WakaTime Integration: Fetches coding statistics from your WakaTime account to display activity metrics.
- Customizable Metrics: Allows users to choose which metrics to display, including total code, lines of code, and time spent coding.
- Flexible Configuration: Supports various flags for customizing the README's appearance, displaying specific information, and controlling the display of data.
- Locale Support: Supports multiple languages with customizable translation in README.
- Workflow Automation: Can be triggered on a schedule or manually through GitHub Actions workflows, updating your README automatically.
- User Experience: Provides clear visual representations of coding activity, enhancing profile visibility and engagement.
- Commit Information: Allows controlling the display of commit statistics including timestamps and activity by day.
The project is actively maintained, with recent commits indicating ongoing development and bug fixes. The README provides detailed instructions and examples for setup and configuration, and the issue tracker is responsive to user feedback. A growing number of stars and forks signify community interest and adoption. The codebase is well-structured and documented, suggesting a solid foundation for future development.
waka-readme-stats benefits developers who want to showcase their coding activity and productivity on GitHub. It provides a simple and effective way to visualize coding statistics, making profiles more informative and engaging. It's valuable for developers seeking to track their progress, demonstrate their commitment to coding, and connect with other developers.