docs: update README for v1.2.0, remove performance claims#112
Merged
FumingPower3925 merged 3 commits intomainfrom Mar 31, 2026
Merged
docs: update README for v1.2.0, remove performance claims#112FumingPower3925 merged 3 commits intomainfrom
FumingPower3925 merged 3 commits intomainfrom
Conversation
- Remove specific performance numbers (3.3M rps, 590K rps, etc.) from Highlights and Benchmarks sections. Redirect to goceleris.dev/benchmarks for current numbers that won't go stale in the README. - Remove nonexistent Performance Profiles section (celeris.Latency, celeris.Throughput, celeris.Balanced were never implemented). - Remove nonexistent Objective field from Config example. - Add v1.2.0 features to Features list: Streaming responses (Detach + StreamWriter), connection hijacking, MaxRequestBodySize, OnExpectContinue, PauseAccept/ResumeAccept, content negotiation, response buffering, zero-downtime restart, CPU utilization monitoring. - Update Observability section with CPUMonitor example. - Update API Overview table with new types: RouteInfo, Cookie, StreamWriter, EngineInfo, CPUMonitor. - Update Feature Matrix with Detach/StreamWriter and connection hijack rows. - Update middleware list with newly-unblocked middlewares (KeyAuth, ETag, Cache). - Fix Project Structure: add celeristest/, fix internal/ subpackages, fix resource/ description (defaults, not objectives). - Update bridge description to reference MaxRequestBodySize instead of hardcoded 100 MB. - Bump Version constant from "1.0.0" to "1.2.0".
SECURITY.md: - Bump supported version from >= 1.1.0 to >= 1.2.0 - Add note about known vulnerabilities in pre-1.2.0 versions (23 issues fixed during v1.2.0 security review: response splitting, cookie injection, null bytes, detach data leakage, request smuggling, etc.) - Expand scope to cover new security surface areas (header sanitization, Detach lifecycle, body size enforcement, callback safety) - Note that goceleris/middlewares has its own security policy CONTRIBUTING.md: - Add prerequisites: golangci-lint v2.9+, h2spec - Add all current mage targets: spec, fuzz, check, benchLinux, etc. - Add Linux Testing section with Multipass VM instructions - Add Benchmarking section (localBenchmark, localProfile) - Add Testing section with test organization conventions - Add commit message format guidance (type: description, CWE references) - Add hot-path code style note (no alloc, no defer for locks) - Link to SECURITY.md for vulnerability reporting
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Versionconstant from"1.0.0"to"1.2.0"Changes
Removed:
celeris.Latency/Throughput/Balanced— never implemented)Objectivefield from Config exampleAdded:
celeristest/in Project StructureTest plan
go build ./...cleango vet ./...clean