Commit 221b608
committed
docs: comprehensive usage guide + README badge updates
- docs/USAGE.md: complete user-facing documentation covering:
- Installation (basic, extras, Rust backend)
- Quick start (route, compress, remember/recall, step)
- Core API reference with examples
- Enterprise features: tenancy, schema validation, rate limiting,
config management, encryption, JWT auth, TTL, health probes, backup/restore
- Observability: telemetry, Prometheus, OpenTelemetry, JSONL export
- Security: pentest command + hardening checklist
- Deployment: blue-green markers, load testing, chaos engineering
- Testing commands
- README.md: updated version badge 0.3.0→0.5.0, tests 15→135,
added link to docs/USAGE.md
Verification: 135/135 tests passing, ruff 0, mypy 01 parent e42c0e3 commit 221b608
2 files changed
Lines changed: 458 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
| 92 | + | |
| 93 | + | |
92 | 94 | | |
93 | 95 | | |
94 | 96 | | |
| |||
0 commit comments