Skip to content

docs: polish README for PyCon#20

Merged
beonde merged 1 commit into
mainfrom
docs/readme-pycon-polish
May 13, 2026
Merged

docs: polish README for PyCon#20
beonde merged 1 commit into
mainfrom
docs/readme-pycon-polish

Conversation

@beonde
Copy link
Copy Markdown
Member

@beonde beonde commented May 12, 2026

Aligns README with marketing copy from capisc.io:

  • Rename from 'A2A validation platform' → 'Catch bad agents before your users do'
  • Add 'What It Checks' table and 'Use Cases' section
  • Add Dev & Testing Commands section (badge/key/gateway are dev tools, not primary use case)
  • Add npm install alternative
  • Add Related Packages ecosystem section with links to Agent Guard, MCP Guard, and capiscio-core
  • Streamline 'How It Works' section
  • Link to capiscio-core for full CLI reference

Copilot AI review requested due to automatic review settings May 12, 2026 05:57
@github-actions
Copy link
Copy Markdown

✅ All checks passed! Ready for review.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project README to match updated CapiscIO marketing messaging and to better separate primary CLI usage from development/testing utilities, while pointing users to capiscio-core for full CLI documentation.

Changes:

  • Rewrites the README intro/positioning and streamlines the “How It Works” explanation.
  • Adds “What It Checks”, “Use Cases”, and “Dev & Testing Commands” sections with examples.
  • Adds an ecosystem “Related Packages” section and links to external documentation.

Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
@beonde beonde merged commit 8df1bdc into main May 13, 2026
22 checks passed
@beonde beonde deleted the docs/readme-pycon-polish branch May 13, 2026 14:38
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.

2 participants