A GitHub Action that automatically updates your README with a list of repositories you've starred on GitHub, categorized by programming language.

How It Works

1. The action fetches all your starred repositories using GitHub API
2. It groups them by programming language
3. It generates a formatted markdown section
4. It updates your README between specified markers

Usage

Basic Setup

Add this to your workflow file (e.g., .github/workflows/update-stars.yml):

name: Update Starred Repositories

on:
  schedule:
    - cron: '5 4 * * *'   # Run daily at 4:05 AM
  workflow_dispatch:      # Allow manual trigger

jobs:
  update-stars:
    runs-on: ubuntu-latest
    
    steps:
      - uses: actions/checkout@v3
      - name: Update README with Starred Repositories
        uses: mxvsh/starkit@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

Customization

You can customize the action by passing additional parameters:

• readme-path: Path to your README file (default: README.md)
• start-marker: Marker to identify section start (default: <!-- STARRED_REPOS_START -->)
• include-languages: Comma-separated list of languages to include (optional)
• exclude-languages: Comma-separated list of languages to exclude (optional)
• sort-by: Sort order (name or count, default: name)
• max-repos: Maximum number of repositories per language (optional)

Future Feature Roadmap

• [ ] Custom badges for each language
• [ ] Categorize by repository topics
• [ ] Group by organization/owner
• [ ] Filter by creation/update date
• [ ] Collapsible sections by language

License

This project is licensed under the MIT License. See the LICENSE file for details.

Credits

This project is inspired by stargazer.