Skip to content

docs: comprehensive README update with security, testing, and TeamCode info#385

Merged
ElioNeto merged 1 commit into
mainfrom
docs/readme-update
May 26, 2026
Merged

docs: comprehensive README update with security, testing, and TeamCode info#385
ElioNeto merged 1 commit into
mainfrom
docs/readme-update

Conversation

@ElioNeto
Copy link
Copy Markdown
Owner

Summary

Complete README overhaul reflecting the current state of the project after the security audit resolution.

Changes

  • Security section: TLS/HTTPS, auth, CORS, rate limiting, CSRF, audit logging, encryption
  • Architecture diagram: Updated with TLS layer, quarantine, degradation, testing layers
  • MemTable: Updated from BTreeMap to DashMap concurrent
  • Configuration table: Key environment variables documented
  • Testing section: Proptest, fuzz, chaos testing commands
  • CI/CD section: PR validation pipeline stages documented
  • Production usage: TeamCode integration highlighted
  • Roadmap: Updated with completed v2.2/v2.3 milestones
  • REST API: Expanded examples table
  • Project structure: Updated file descriptions

…e info

- Add security features section (TLS, auth, CSRF, audit, rate limiting)
- Update architecture diagram with TLS, quarantine, testing layers
- Update MemTable from BTreeMap to DashMap concurrent
- Add configuration table with key environment variables
- Add testing section with proptest, fuzz, chaos commands
- Add PR validation pipeline details
- Add TeamCode production usage section
- Update roadmap with completed items
- Add REST API examples table
- Restructure and modernize all sections
@ElioNeto ElioNeto merged commit 44f1058 into main May 26, 2026
13 of 14 checks passed
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