Skip to content

docs: add comprehensive usage analytics badges#49

Merged
ddjain merged 1 commit intomainfrom
docs/add-usage-analytics-badges
Oct 30, 2025
Merged

docs: add comprehensive usage analytics badges#49
ddjain merged 1 commit intomainfrom
docs/add-usage-analytics-badges

Conversation

@ddjain
Copy link
Member

@ddjain ddjain commented Oct 30, 2025

📊 Summary

Adds comprehensive usage analytics badges and documentation to help track community adoption.

✨ What's Added

New Badges (8 total):

  1. GitHub Stars - Community interest & endorsement
  2. 🔱 GitHub Forks - Active usage & customization
  3. 👁️ GitHub Watchers - Active monitoring
  4. 📝 GitHub Issues - Open issues count
  5. 🔀 GitHub PRs - Open pull requests count
  6. 🔗 Used by - Public repos using this action (dynamic)
  7. 📅 Last Commit - Maintenance status
  8. 🏷️ Latest Release - Version tracking

New Documentation Section:

  • 📊 Usage Analytics section explaining:
    • What each badge measures
    • Why it matters for adoption
    • Note about private repos (2-5x usage multiplier)
    • How GitHub Marketplace analytics work
    • Where insights will be available after publication

🎯 Benefits

Track adoption - See how many repos are using the action
Community engagement - Monitor stars, forks, issues
Maintenance transparency - Show active development
Social proof - Build trust with potential users
Professional appearance - Industry-standard badges

📸 Preview

The badges appear prominently at the top of the README:

  • First row: Static project badges (GitHub, License, Coverage)
  • Second row: Dynamic usage/analytics badges (Stars, Forks, etc.)

🔍 Technical Details

  • All badges use shields.io for consistency
  • Social badges (style=social) for stars/forks/watchers
  • Dynamic badge for "Used by" count (updates automatically)
  • Links to relevant GitHub pages for each metric
  • No external analytics services required (pure GitHub API)

📚 Addresses User Request

User asked: "is there any way to have analytics in which we will be able to understand how many time this workflow been called by community?"

This PR provides:

  1. ✅ Corrected information about Marketplace insights
  2. ✅ Multiple tracking badges showing community adoption
  3. ✅ Clear explanation of what can be tracked
  4. ✅ Guidance on GitHub's built-in analytics features

Added usage tracking badges to README:
- GitHub stars (social engagement)
- GitHub forks (adoption indicator)
- GitHub watchers (active monitoring)
- Open issues/PRs (community activity)
- Used by count (public repos using the action)
- Last commit (maintenance status)
- Latest release (version tracking)

Also added Usage Analytics section explaining:
- What each badge measures
- Why it matters for adoption metrics
- Note about private repos (2-5x multiplier)
- How GitHub Marketplace analytics work
- Where to find insights after publication

These badges help track community adoption and usage patterns.
@ddjain ddjain merged commit 914e738 into main Oct 30, 2025
5 checks passed
@ddjain ddjain deleted the docs/add-usage-analytics-badges branch October 30, 2025 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant