Skip to content

docs: demo video in the README - #7

Merged
m4sh-wacker merged 3 commits into
mainfrom
docs/readme-video
Oct 22, 2026
Merged

m4sh-wacker merged 3 commits into
mainfrom
docs/readme-video

Conversation

@m4sh-wacker

Copy link
Copy Markdown
Collaborator

Replaces the README screenshot with a 75-second walkthrough video (detection and evidence, layered findings with CWEs, CTF search, recipes, save and share, offline single file).

  • The video is a GitHub upload, since GitHub only embeds video from its own uploads. It is linked in angle brackets so markdownlint's no-bare-urls rule stays happy.
  • .spellcheck.yaml skips github.com/user-attachments links: their ids are random characters, not words.
  • docs/screenshot.png was only used in the README, so it is removed.

The screenshot showed one decode; the video walks through detection,
evidence, nested findings, CTF search, recipes and the offline build.
GitHub only embeds video from its own uploads, so the README links the
uploaded file, and the spell check skips those links (their ids are
random, not words). docs/screenshot.png was only used here.
@m4sh-wacker
m4sh-wacker merged commit 20193c2 into main Oct 22, 2026
9 checks passed
@m4sh-wacker
m4sh-wacker deleted the docs/readme-video branch October 22, 2026 13:10
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