readme2demo can now sit in your GitHub Actions workflow and fail the build when your README breaks.
The Action
~15 lines of YAML: the pipeline runs your README inside a hardened Docker sandbox, replays the distilled steps in a fresh container, and the check goes red only when that clean-room replay fails — a red X means a real container tried your README and it didn't survive.
name: readme-check
on:
push:
branches: [main]
paths: ["README.md"]
schedule:
- cron: "0 6 * * 1" # weekly: catch the world changing under an unchanged README
jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: alphacrack/readme2demo@v0.7.0
with:
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}