Skip to content

docs(readme): status badges + clearer setup intro#52

Merged
lex00 merged 1 commit into
mainfrom
docs/readme-intro-badges
Jun 19, 2026
Merged

docs(readme): status badges + clearer setup intro#52
lex00 merged 1 commit into
mainfrom
docs/readme-intro-badges

Conversation

@lex00

@lex00 lex00 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Addresses two bits of feedback: surface build/e2e status, and make the intro state plainly what setup someone is in for.

Badges

ci, e2e (nightly), and npm version — all verified to resolve (200).

Intro rewrite

  • One-line framing: "Think of it as Terraform for GitHub administration."
  • New "What you need to run it" section up front — the two prerequisites stated plainly:
    1. Auth — a pre-minted token (simple) or a GitHub App installed on the org (required for org-level + token cycles).
    2. A config file declaring desired state.
  • Calls out that dry-run is the default (reads only, changes nothing) so it's safe to try first.

Docs-only.

🤖 Generated with Claude Code

Add ci / nightly-e2e / npm badges. Rewrite the intro to orient newcomers:
a one-line "Terraform for GitHub admin" framing, and a new "What you need
to run it" section that states the two prerequisites up front (auth — token
or a GitHub App; and a config file) and that dry-run is the safe default.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@lex00 lex00 merged commit 5d39e62 into main Jun 19, 2026
2 checks passed
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