GitHub Badge & Dashboard

Display your semantic health score on your GitHub README. Automatic updates on every commit.

Check Your Repository

Enter your GitHub repository URL to see its semantic health score

Automatic Updates

Your badge automatically updates on every commit. No manual updates needed.

  • •Real-time semantic health monitoring
  • •CI/CD integration via GitHub Actions
  • •Instant violation detection

Public Dashboard

Clicking your badge takes visitors to a beautiful public dashboard.

  • •Semantic health trends over time
  • •Constraint violation history
  • •Share proof of code quality

Setup Instructions

1

Install APX GitHub Action

name: APX Semantic Check
on: [push, pull_request]

jobs:
  apx:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: apx/action@v1
        with:
          upload-badge: true
2

Add Badge to README

Copy the markdown from above and paste it at the top of your README.md

3

Commit and Push

Your badge will automatically update on every commit. Click it to see your dashboard.

Why Badges Drive Adoption

  • • Social Proof: Developers trust projects with high health scores
  • • Natural Discovery: Visitors see APX and want it for their projects
  • • Competitive Edge: Stand out with visible code quality metrics
  • • Team Motivation: Everyone loves seeing the score improve