Skip to content

docs: polish README — live links, run-it-3-ways, footer#12

Merged
iamrraj merged 1 commit into
mainfrom
docs/readme-polish
Jun 18, 2026
Merged

docs: polish README — live links, run-it-3-ways, footer#12
iamrraj merged 1 commit into
mainfrom
docs/readme-polish

Conversation

@iamrraj

@iamrraj iamrraj commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Polishes the README:

  • Header links the live site, examples & docs (+ website badge)
  • New Three ways to install & run it table (CLI / Action / App) so install+run for every distribution is clear up front
  • Centered footer with the logo + name + project links
  • Repo topics set for discoverability

No code changes.

- header now links the live site, examples, and docs (+ website badge)
- new 'Three ways to install & run it' selector table (CLI / Action / App)
- centered footer with the logo, name, and project links
- fixed two in-page anchors (#-testing, #-contributing)
@iamrraj iamrraj merged commit deeb144 into main Jun 18, 2026
@shipit-forge

shipit-forge Bot commented Jun 18, 2026

Copy link
Copy Markdown

👀 ShipIT Forge is running a code + security review on this PR… I'll post my review shortly.

@iamrraj iamrraj deleted the docs/readme-polish branch June 18, 2026 17:30
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