Skip to content

docs: premium README lift + cover banner - #70

Merged
FumingPower3925 merged 1 commit into
mainfrom
docs/readme-lift-and-cover
Jul 4, 2026
Merged

docs: premium README lift + cover banner#70
FumingPower3925 merged 1 commit into
mainfrom
docs/readme-lift-and-cover

Conversation

@FumingPower3925

Copy link
Copy Markdown
Contributor

Premium README lift + cover banner

Refreshes the loadgen README against the v1.4.13 code and adds a branded .github/cover.png banner (part of the cohesive goceleris family).

Content

  • Added: a top-level Load modes section covering the built-in streaming drivers (ws-echo / ws-large-echo / ws-hub / sse-fanout) alongside H1/H2/h2c-upgrade/mix; rated mode (Gil-Tene coordinated-omission correction); federation; HdrHistogram export; self-instrumentation (cpu_pct_p95, recvq_high); the v1.4.13 server-preface WINDOW_UPDATE fix; a Config reference table.
  • Accuracy fixes: percentiles come from a merged HdrHistogram, not reservoir sampling; the JSON schema table is regenerated from results.go (drops the nonexistent bytes/bytes_per_sec, adds ~13 real fields); the "zero allocation" claim is scoped to a design goal; the CLI flag table gains 8 missing flags; the release-download example is bumped to v1.4.13; WebSocket/SSE are documented as built-in modes rather than hypothetical custom handlers.

Verified against source, then adversarially fact-checked.

- Add .github/cover.png banner.

- Document built-in streaming load modes (ws-echo/ws-large-echo/ws-hub/sse-fanout), rated/coordinated-omission mode, federation, HdrHistogram export, and CPU/recv-queue self-instrumentation.

- Regenerate the JSON schema + CLI flag tables from source; fix the reservoir->HdrHistogram percentile claim; scope the zero-alloc claim; bump the release-download example to v1.4.13.
@FumingPower3925
FumingPower3925 merged commit 87cea05 into main Jul 4, 2026
3 checks passed
@FumingPower3925
FumingPower3925 deleted the docs/readme-lift-and-cover branch July 4, 2026 07:56
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