Skip to content

docs: dual-audience README for executives and engineers#8

Merged
AdamDiStefanoAI merged 1 commit intomainfrom
docs/killer-readme
Apr 8, 2026
Merged

docs: dual-audience README for executives and engineers#8
AdamDiStefanoAI merged 1 commit intomainfrom
docs/killer-readme

Conversation

@AdamDiStefanoAI
Copy link
Copy Markdown
Owner

Summary

  • Rewrites the top-level README as a single dual-audience document
  • Executive track: plain-language problem/outcomes, regulatory context, 30-minute evaluation guide, board-ready bottom line
  • Engineering track: 60-second quickstart, Mermaid sequence diagram of the /acr/evaluate hot path, ASCII architecture, six-pillar technical table, agent registry field reference, API surface, compliance mappings, repo layout

Notes

  • Uses the existing acr-framework.png at repo root for the hero image — replace that file if you want the updated bold-blue logo to render
  • No code or behavior changes; docs only

🤖 Generated with Claude Code

Rewrites the top-level README as a single document that serves both
non-technical security executives (plain-language outcomes, regulatory
context, 30-min eval guide) and engineers (quickstart, sequence diagram,
architecture, pillar internals, API surface, compliance mappings).
@AdamDiStefanoAI AdamDiStefanoAI merged commit d6fab51 into main Apr 8, 2026
1 check failed
@AdamDiStefanoAI AdamDiStefanoAI deleted the docs/killer-readme branch April 8, 2026 05:59
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