Skip to content

Commit a8d5f57

Browse files
authored
Enhance README with project overview and badges
Added introductory section with project details and badges.
1 parent c5b09b0 commit a8d5f57

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,51 @@
1818
╚══════════════════════════════════════════════════════════════════════╝
1919
```
2020

21+
<div align="center">
22+
<h1>Zypheron CLI</h1>
23+
<h3>AI-Powered Penetration Testing Platform</h3>
24+
25+
<p>
26+
<a href="https://go.dev/"><img src="https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&logoColor=white" alt="Go"></a>
27+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.9+-3776AB?logo=python&logoColor=white" alt="Python"></a>
28+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a>
29+
<a href="#integrated-tools"><img src="https://img.shields.io/badge/Security_Tools-50%2B-2ea44f" alt="Tools"></a>
30+
<a href="#ai-providers"><img src="https://img.shields.io/badge/AI_Models-10%2B-8a2be2" alt="AI Models"></a>
31+
</p>
32+
33+
<p>Advanced AI-assisted pentesting CLI in Go with autonomous orchestration and multi-model intelligence.</p>
34+
35+
<!-- TODO: Replace with actual asciinema recording
36+
<a href="https://asciinema.org/a/YOUR_RECORDING_ID">
37+
<img src="https://asciinema.org/a/YOUR_RECORDING_ID.svg" width="800" alt="Zypheron AutoPent Demo">
38+
</a>
39+
-->
40+
41+
<p><a href="CHANGELOG.md">What's New</a> • <a href="#architecture-overview">Architecture</a> • <a href="docs/INSTALL.md">Installation</a> • <a href="#features">Features</a> • <a href="#ai-providers">AI Providers</a> • <a href="docs/MCP_INTEGRATION.md">API/MCP</a></p>
42+
</div>
43+
44+
---
45+
46+
## Follow Us
47+
48+
[![Discord](https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white)](https://discord.gg/)
49+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Follow-0A66C2?logo=linkedin&logoColor=white)](https://www.linkedin.com/)
50+
51+
## Architecture Overview
52+
53+
Zypheron combines command orchestration, tool-chain automation, and AI-guided analysis in one CLI.
54+
55+
```mermaid
56+
flowchart TD
57+
U[User / Operator] --> C[Zypheron CLI]
58+
C --> P[Planner + Agent Router]
59+
P --> T[Security Tool Chains]
60+
P --> A[AI Model Layer]
61+
T --> R[Findings + Artifacts]
62+
A --> R
63+
R --> O[Reports / Sessions / Recommendations]
64+
```
65+
2166
## Quick Start
2267

2368
```bash

0 commit comments

Comments
 (0)