Skip to content

Commit 4a96cc5

Browse files
GeneAIclaude
authored andcommitted
docs: Update README to reflect v3.5.x release
- Updated 'What's New' section to v3.5.x - Added Memory API Security Hardening features - Reorganized previous version sections 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 0557f84 commit 4a96cc5

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,29 @@
1212
pip install empathy-framework[full]
1313
```
1414

15-
## What's New in v3.3.x
15+
## What's New in v3.5.x
1616

17-
### Enterprise-Ready Workflows
17+
### Memory API Security Hardening (v3.5.0)
1818

19-
- **Formatted Reports for All Workflows** — Every workflow now includes `formatted_report` with consistent structure, status icons, and actionable summaries
20-
- **Enterprise-Safe Doc-Gen** — Auto-scaling tokens, chunked generation, cost guardrails ($5 default limit), graceful degradation, and file export
21-
- **Output Chunking** — Large reports automatically split into displayable sections to avoid truncation
19+
- **Input Validation** — Pattern IDs, agent IDs, and classifications validated to prevent path traversal and injection attacks
20+
- **API Key Authentication** — Bearer token and X-API-Key header support with SHA-256 hash comparison
21+
- **Rate Limiting** — Per-IP sliding window rate limiting (100 req/min default)
22+
- **HTTPS/TLS Support** — Optional SSL certificate configuration for encrypted connections
23+
- **CORS Restrictions** — Configurable allowed origins (localhost-only by default)
24+
- **Request Size Limits** — 1MB body limit to prevent DoS attacks
2225

23-
### Unified CLI & Developer Experience
26+
### Previous (v3.4.x)
2427

25-
- **Unified Typer CLI**One `empathy` command with Rich output, subcommand groups, and cheatsheet
26-
- **Dev Container Support**One-click VS Code dev environment with Docker Compose
27-
- **Python 3.13 Support**Test matrix now covers 3.10-3.13 across macOS, Linux, Windows
28+
- **Trust Circuit Breaker**Automatic degradation when model reliability drops
29+
- **Pattern Catalog System**Searchable pattern library with similarity matching
30+
- **Memory Control Panel**VSCode sidebar for Redis and pattern management
2831

29-
### Documentation Overhaul
32+
### Previous (v3.3.x)
3033

31-
- **Diátaxis Framework** — Restructured docs into Tutorials, How-to, Explanation, Reference
32-
- **Improved Navigation** — Clearer paths from learning to mastery
33-
- **Fixed Asset Loading** — CSS now loads correctly on all documentation pages
34+
- **Formatted Reports** — Every workflow includes `formatted_report` with consistent structure
35+
- **Enterprise-Safe Doc-Gen** — Auto-scaling tokens, cost guardrails, file export
36+
- **Unified Typer CLI** — One `empathy` command with Rich output
37+
- **Python 3.13 Support** — Test matrix covers 3.10-3.13 across all platforms
3438

3539
### Previous (v3.1.x)
3640

@@ -142,6 +146,17 @@ Install the Empathy VSCode extension for:
142146
- **One-Click Workflows** — Research, code review, debugging
143147
- **Visual Cost Tracking** — See savings in real-time
144148
- See also: `docs/dashboard-costs-by-tier.md` for interpreting the **By tier (7 days)** cost breakdown.
149+
- **Memory Control Panel (Beta)** — Manage Redis and pattern storage
150+
- View Redis status and memory usage
151+
- Browse and export stored patterns
152+
- Run system health checks
153+
- Configure auto-start in `empathy.config.yml`
154+
155+
```yaml
156+
memory:
157+
enabled: true
158+
auto_start_redis: true
159+
```
145160
146161
### Level 5: Custom Agents
147162

0 commit comments

Comments
 (0)