Skip to content

Refresh README with animated hero, pipeline graphic and website link - #2

Merged
suriya4code merged 1 commit into
mainfrom
docs/readme-visuals
Oct 23, 2026
Merged

suriya4code merged 1 commit into
mainfrom
docs/readme-visuals

Conversation

@suriya4code

Copy link
Copy Markdown
Owner

Requested by AK · project thread

Summary

Brings the README in line with the new website. GitHub READMEs can't run JavaScript, so the motion comes from pre-rendered media and CSS-animated SVG.

  • Animated hero banner (assets/readme/hero.webp, 1000×469, 1.2 MB): the site's 3D scale ball, rendered frame by frame from the real page. It spins open, curls shut with the green lock ring, then unrolls. Clicking it opens the website.
  • A Website badge and a quick-links row (Website · Build · Security · Architecture · Sponsor). Two crypto badges join the existing ones.
  • An animated encryption-pipeline SVG (assets/readme/pipeline.svg, 6 KB) in the Security section. A glowing packet travels password → PBKDF2 → HKDF → AES-256-GCM → verify. Each node lights up as it passes, and the path flips from ~/Documents/TripsAndTours to a .plock ciphertext. It respects prefers-reduced-motion.
  • A Hide vs Lock comparison table, and the 9 features as a 3×3 card grid.
  • The architecture diagram goes in a collapsible <details> block.
  • Requirements, Build & run, Contributing, Support and License are unchanged. The banner replaces the assets/logo.png lockup at the top of the README; the file itself stays.

Type of change

  • Bug fix
  • New feature
  • Refactor / chore
  • Docs

How was this tested?

  • Rendered the pushed branch's README page on github.com in headless Chromium. The animated WebP plays and the SVG renders and animates.

  • Checked the SVG with xmllint and captured mid-animation frames of it.

  • No app code changed.

  • xcodebuild test passes (build + unit tests green); left to CI since no app code changed

  • Added/updated tests for the change (not applicable)

  • Manual steps that can't be tested headlessly are listed below

Manual check: view the README on github.com in light and dark mode.

Security checklist

  • No plaintext secrets written to disk or logs
  • No paywall / StoreKit / feature‑gating introduced
  • Destructive operations keep a confirmation/guardrail (not applicable)
  • SECURITY.md / docs/ARCHITECTURE.md updated if the threat model changed (unchanged)
  • CHANGELOG.md updated under Unreleased

Generated by Claude Code

- Animated WebP banner of the site's 3D scale-ball hero, linking to the
  live GitHub Pages site, plus a prominent Website badge and quick links.
- Animated SVG of the encryption pipeline (password, PBKDF2, HKDF,
  AES-256-GCM, verify-then-delete) in the Security section.
- Hide vs Lock comparison table, features as a 3x3 card grid, extra
  crypto badges, and the architecture diagram in a collapsible block.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ga1HHxirLFkYMbeFNay8aX
@suriya4code suriya4code self-assigned this Oct 23, 2026
@suriya4code
suriya4code merged commit 49d584e into main Oct 23, 2026
1 check 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.

2 participants