Background
The README's Quick Start section documents --format json,html (see the "Write only the report formats you want" example) but doesn't have a dedicated section explaining what each of the four formats (json, csv, pdf, html) contains, or a known, intentional quirk: CSV always writes a header-only file when there are zero vulnerabilities, even if csv is in the requested --format list (see docs/CHANGELOG.md's Phase 2 notes). A new user piping that CSV into something expecting at least one data row could be confused by an empty-looking file that isn't actually broken.
Task
Add a short "Report formats" subsection to the README (near the existing "Machine-readable output" / "SARIF output" sections) that:
- Briefly describes what's in each of
json, csv, pdf, html
- Notes the CSV header-only-on-zero-findings behavior explicitly, so it reads as intentional rather than a bug
- Links out to
--json and --sarif's existing dedicated sections rather than duplicating them
Acceptance criteria
Pointers
README.md — search for --format json,html and the "Machine-readable output" heading for where this fits
docs/CHANGELOG.md — search for "header-only" for the exact behavior to describe
Background
The README's Quick Start section documents
--format json,html(see the "Write only the report formats you want" example) but doesn't have a dedicated section explaining what each of the four formats (json,csv,pdf,html) contains, or a known, intentional quirk: CSV always writes a header-only file when there are zero vulnerabilities, even ifcsvis in the requested--formatlist (seedocs/CHANGELOG.md's Phase 2 notes). A new user piping that CSV into something expecting at least one data row could be confused by an empty-looking file that isn't actually broken.Task
Add a short "Report formats" subsection to the README (near the existing "Machine-readable output" / "SARIF output" sections) that:
json,csv,pdf,html--jsonand--sarif's existing dedicated sections rather than duplicating themAcceptance criteria
--json/--sarifsections, just cross-references themPointers
README.md— search for--format json,htmland the "Machine-readable output" heading for where this fitsdocs/CHANGELOG.md— search for "header-only" for the exact behavior to describe