Skip to content

Commit 92528d8

Browse files
authored
Merge pull request #18 from devonartis/fix/readme-audit-wording
fix: clarify audit scope in README
2 parents d663ec4 + 5d92b55 commit 92528d8

2 files changed

Lines changed: 182 additions & 469 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Changed — README overhaul for scannability and wayfinding (2026-04-13)
11+
12+
- **`README.md`** — full restructure for newcomers who scan, not read:
13+
- Quick Start collapsed to one path (Docker Hub), 5 commands, no inline explanations. "Next steps" decision table immediately after.
14+
- "Why this matters" side-by-side comparison table replaces prose bullet list.
15+
- "How it works" simplified mermaid flow with numbered steps. Component table links to source packages.
16+
- API table adds "Who uses it" column so each role finds their endpoints fast.
17+
- Documentation section reframed as "I want to..." intent-based navigation.
18+
- Configuration collapsed to one essential table + link to operator guide.
19+
- TLS/mTLS/nginx config, cosign verification, image tag details moved to docs (not README).
20+
- Audit trail wording clarified: broker logs credential lifecycle events, not agent activity at the resource server.
21+
- Net: 169 insertions, 469 deletions — README is now a landing page, not a manual.
22+
1023
### Fixed — stale agentauth brand refs missed in rebrand (2026-04-13)
1124

1225
- **`SECURITY.md`** — contact emails `security@agentauth.dev``security@agentwrit.com`; all "AgentAuth" brand references → "AgentWrit".

0 commit comments

Comments
 (0)