docs: promote Quick Start and release downloads

[SH4DY]

Why

Make the primary invocation command easy to find and clarify the available distribution options.

How

Move Quick Start above Highlights and present uvx and standalone GitHub Release paths, including links to binaries, SBOMs, checksums, and source archives.

Slack Thread

  

[qodo-merge-etso]

PR Summary by Qodo

Docs: move Quick Start to top and document uvx vs release binary paths

📝 Documentation 🕐 10-20 Minutes

AI Description

• Promote Quick Start above Highlights so the primary run command is immediately visible.
• Document two distribution options: uvx (Python package) and standalone GitHub Release binaries.
• Add links and guidance for release artifacts (SBOMs, checksums, source archives) and verification.

Diagram

graph TD
U(("User")) --> R["README: Quick Start"] --> T[/"Set SNYK_TOKEN"/] --> C{"Choose distribution"}
C --> UV["Run via uvx"] --> S["Run scan"]
C --> GH[["Download GitHub Release"]] --> V["Verify binary"] --> S
subgraph Legend
direction LR
_u(("Actor")) ~~~ _doc["Doc section"] ~~~ _ext[["External source"]] ~~~ _step[/"Shell step"/] ~~~ _dec{"Decision"}
end

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Add a short “Install” table (uvx vs binary) plus a mini-TOC

• ➕ Improves scannability further for long README pages
• ➕ Makes it easier to find verification/details sections without scrolling
• ➖ Adds more structure/maintenance overhead in README
• ➖ May be redundant if GitHub renders a TOC or readers rely on page search

2. Move distribution details to a dedicated INSTALL.md / docs page

• ➕ Keeps README minimal while allowing richer installation and verification instructions
• ➕ Easier to expand platform-specific guidance over time
• ➖ Adds navigation friction for first-time users
• ➖ Requires keeping multiple docs pages in sync

Recommendation: Current approach is appropriate for the stated goal (make the primary invocation easy to find) because it keeps the critical commands and distribution choices directly in the README above the fold. If the README continues to grow, consider adding a small install/options table or extracting deeper verification/platform guidance to a dedicated doc page later.

Files changed (1) +44 / -41

Documentation (1) +44 / -41

README.mdPromote and expand Quick Start with uvx + standalone release guidance +44/-41

Promote and expand Quick Start with uvx + standalone release guidance

• Moves Quick Start above Highlights and reframes it around two supported distribution paths: running via 'uvx' or downloading a standalone binary from GitHub Releases. Adds clearer prerequisites (SNYK_TOKEN), includes links and notes about release artifacts (SBOMs/checksums/source archives), and aligns headings (e.g., Example Run).

README.md

[qodo-merge-etso]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

[xzhou-snyk]

Shall we call it Run with standalone binary just to be consistent with the wording?

[xzhou-snyk]

This image is only for uvx so shall we call it Example uvx Run?

Then would be nice to also provide a screenshot for the Example Binary Run.

[SH4DY]

I feel like we shouldn't add more bloat to the main README, it's already too long.