Skip to content

docs: README header with logo, badges, split quick start - #27

Open
khalid-offset wants to merge 1 commit into
mainfrom
docs/readme-header
Open

khalid-offset wants to merge 1 commit into
mainfrom
docs/readme-header

Conversation

@khalid-offset

Copy link
Copy Markdown
Contributor

README only, no code changes.

  • Centred logo header and a link row (Quick start, Features, How it compares, Methodology, Downloads)
  • Badges: latest release (pre-releases included), CI, CodeQL, Go version, a real Go Reference (pkg.go.dev), CycloneDX 1.7, license. The old "Go Reference" alt text was on the Go-version badge; Go Report Card is left out because the service now shows "retired".
  • Pre-release note moved to the top as a GitHub NOTE callout
  • Quick start split into Docker/Podman, Debian/Ubuntu (with the real RPM file name), Windows and any OS, so it no longer reads as one script
  • Overview screenshot switches to overview-dark.png in dark mode

go test ./internal/archtest/ ./web/ pass (README link and Go-version badge checks).

Logo header, release/CI/CodeQL/pkg.go.dev badges, a link row, the
pre-release note near the top, the quick start split by install method
(with the real RPM file name), and a screenshot that follows dark mode.
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