Skip to content

docs: premium README lift + cover banner + benchmark hero - #405

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

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

Conversation

@FumingPower3925

Copy link
Copy Markdown
Contributor

Premium README lift + cover banner + benchmark hero

Refreshes the celeris README end-to-end and adds branded imagery under .github/.

Imagery

  • .github/cover.png — a premium hero banner, part of a cohesive goceleris family (celeris / loadgen / probatorium / docs) that shares one visual language with a per-repo accent.
  • .github/benchmark.png — a throughput leaderboard in a new Benchmarks section: plaintext GET / @ 1024 connections, saturation req/s, linux/amd64, v1.5.6 bench data — celeris Project scaffolding and CI pipeline #1 of a 45-server, 10-language field, ahead of hand-tuned C (h2o), C++ (lithium, drogon), Rust (actix) and Java (netty). Every number is pulled straight from the published results/ tree and scoped honestly (labels the scenario + "best config per framework").

Content

  • Added: the v1.5.7 inline WebSocket/SSE broadcast egress story; a Streaming (SSE / WebSocket / chunked) section; the WebSocket + SSE API surface; a Database drivers section (first-party postgres/redis/memcached); the cmd/celeris CLI.
  • Accuracy fixes: Go 1.26.4+ floor; split the std Detach vs StreamWriter feature-matrix cell; store is TTL-based (not LRU); nightly validation is 24 cells / ~1h; name test/benchcmp_sse.

Every command, path, version and API name was verified against the code, then adversarially fact-checked a second time.

- Add .github/cover.png banner and a Benchmarks section with the throughput hero chart (.github/benchmark.png).

- Document the v1.5.7 inline WebSocket/SSE broadcast egress, the WebSocket/SSE streaming APIs, and the first-party event-loop DB drivers.

- Accuracy: Go 1.26.4+ floor; split the std Detach vs StreamWriter feature-matrix cell; TTL (not LRU) store; nightly = 24 cells / ~1h; name test/benchcmp_sse.
@FumingPower3925
FumingPower3925 merged commit f95a488 into main Jul 4, 2026
7 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