Skip to content

Releases: vergissberlin/codestats-readme

v0.1.0 - First Stable Release 🎉

09 Sep 13:54

Choose a tag to compare

🚀 First Stable Release

CodeStats README is now ready for production use! This GitHub Action automatically updates your profile README with beautiful ASCII charts showing your coding activity from CodeStats.

✨ Features

  • 📊 Beautiful ASCII Charts - Clean, visual representation of your coding activity
  • 🎯 Top 6 Languages - Shows your most used programming languages
  • 🔄 Auto-sorted - Languages sorted by experience points (XPs)
  • Fast & Reliable - Built with Node.js 20 and comprehensive tests
  • 🐳 Docker Support - Available as container image
  • 🔧 Customizable - Multiple configuration options

🚀 Quick Start

  1. Add markers to your README:

    <!-- START_SECTION:codestats -->
    <!-- END_SECTION:codestats -->
  2. Create a workflow:

    - uses: vergissberlin/codestats-readme@v0.1.0
      with:
        CODESTATS_USERNAME: your-codestats-username

🔧 Configuration

Input Description Default
CODESTATS_USERNAME Your CodeStats username Required
README_FILE Path to README file ./README.md
SHOW_TITLE Show update timestamp false
SHOW_LINK Show link to your profile false
GRAPH_WIDTH Width of the ASCII bars 42
COMMIT_MESSAGE Custom commit message Update codestats metrics

🧪 Technical Highlights

  • 100% Test Coverage - 30 comprehensive tests covering all scenarios
  • Robust Error Handling - Handles API failures, malformed data, and edge cases
  • Mock Data Testing - Complete test suite with realistic API scenarios
  • Modern Architecture - ES modules, async/await, Node.js 20
  • Developer-Friendly - Comprehensive documentation in CONTRIBUTING.md

📦 Docker Support

Available on GitHub Container Registry:

docker run ghcr.io/vergissberlin/codestats-readme:v0.1.0

🤝 Contributing

See CONTRIBUTING.md for development setup, testing, and contribution guidelines.

🙏 Acknowledgments

Thanks to CodeStats for providing the awesome coding activity tracking platform!


Full Changelog: https://github.com/vergissberlin/codestats-readme/commits/v0.1.0