Skip to content

docs(readme): live GIFs + v2.5.0 highlights - #77

Merged
kocaemre merged 1 commit into
developfrom
docs/readme-glowup
Jun 22, 2026
Merged

kocaemre merged 1 commit into
developfrom
docs/readme-glowup

Conversation

@kocaemre

Copy link
Copy Markdown
Owner

Summary

Brings the README to life for the v2.5.0 launch — adds animated GIFs of the real app and refreshes the structure.

What changed

  • Hero GIF — an animated port-heatmap (paste nmap → KB-driven cards with risk colors & checks) replaces the static hero shot.
  • "✨ See it in action" — a 2×2 GIF grid of the headline features: AI Explain, the cross-host attack plan, the bring-your-own-model picker (FREE badges + live cost), and usage & cost analytics.
  • "🆕 New in v2.5.0" — a concise highlight of the opt-in AI co-pilot, Exam Mode, cross-host summary, web-augmented :online, usage analytics, and version-aware KB.
  • Tasteful emoji section markers (kept in moderation).

Assets

  • GIFs captured from the real app (Playwright recording of the actual UI), optimized with 128-color palettes — ~6.8 MB total under docs/media/.
  • .gitattributes marks *.gif/*.png/*.mp4 as binary.

No code changes — docs only.

🤖 Generated with Claude Code

Make the README come alive for the launch:
- Hero is now an animated port-heatmap GIF (paste nmap → KB-driven cards).
- New "✨ See it in action" 2×2 GIF grid: AI Explain, cross-host attack plan,
  bring-your-own-model picker, and usage/cost analytics — all real app capture.
- New "🆕 New in v2.5.0" section summarizing the opt-in AI co-pilot, Exam Mode,
  cross-host summary, web-augmented :online, usage analytics, and version-aware KB.
- Tasteful emoji section markers (kept in moderation).
- GIFs live under docs/media/ (~6.8 MB total, optimized 128-color palettes);
  mark media binary in .gitattributes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WDoCrduJx7h9Dv8XaTqrSr
@kocaemre
kocaemre merged commit 1124d2a into develop Jun 22, 2026
3 checks passed
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