Skip to content

docs: add API link and gap diagram to README #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chaksaray merged 1 commit into from
Jul 31, 2026
Merged

docs: add API link and gap diagram to README #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ mapped to the frameworks security teams already report against.
[![Security Policy](https://img.shields.io/badge/security-policy-blue?style=flat-square)](SECURITY.md)
[![Code of Conduct](https://img.shields.io/badge/code%20of%20conduct-Contributor%20Covenant-blueviolet?style=flat-square)](CODE_OF_CONDUCT.md)

[Registry](https://aveproject.org/registry.html) · [Schema](https://aveproject.org/schema.html) · [Crosswalks](https://aveproject.org/crosswalks.html) · [Architecture](https://aveproject.org/architecture.html) · [Scoring](https://aveproject.org/scoring.html) · [Scanner](https://github.com/bawbel/scanner)
[Registry](https://aveproject.org/registry.html) · [Schema](https://aveproject.org/schema.html) · [Crosswalks](https://aveproject.org/crosswalks.html) · [Architecture](https://aveproject.org/architecture.html) · [Scoring](https://aveproject.org/scoring.html) · [API](https://api.aveproject.org) · [Scanner](https://github.com/bawbel/scanner)

</div>

Expand Down Expand Up @@ -62,6 +62,10 @@ It does not scan your SKILL.md for prompt injection.
AVE + Bawbel fixes that.
```

<p align="center">
<img src="docs/images/ave-gap-diagram.svg" alt="Two independent scanners flag the same behavioral pattern under different names, with no shared identifier; AVE fills that gap" width="640" />
</p>

---

## How it works
Expand Down Expand Up @@ -491,6 +495,7 @@ See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for community standards.
| [aveproject.org](https://aveproject.org) | Public registry and documentation |
| [bawbel/scanner](https://github.com/bawbel/scanner) | Reference implementation |
| [aveproject/ave-site](https://github.com/aveproject/ave-site) | Website source |
| [api.aveproject.org](https://api.aveproject.org) | Reference API, live lookup by AVE ID (Pattern 1 above) |
| [OWASP AIVSS v0.8](https://aivss.owasp.org) | Scoring specification |
| [MITRE ATLAS](https://atlas.mitre.org) | AI threat technique catalog |
| [OWASP MCP Top 10](https://owasp.org) | MCP attack surface framework |
Expand Down
0 images/ave-gap-diagram.svg → docs/images/ave-gap-diagram.svg
View file
Open in desktop
File renamed without changes
Loading