Skip to content

Update README hero GIF and add demo screenshots for v0.2.x features #5

Description

@arpitagarwal1301

The README's visual assets are stuck at the v0.1.0 era and don't reflect any of the v0.2.x features that have shipped. This issue captures what needs to be captured and added.

Current state

  • Hero GIF (.github/assets/wardlume-hero.gif) predates the entire v0.2.x line — shows only the original full-shader aesthetic, no reaction packs, no bait-and-switch, no corner indicator
  • Touch ID unlock GIF — referenced as a placeholder, never created
  • Three v0.2.x TODO screenshots called out in README's ## Custom Assets section: Preferences UI, silentProfessional ward, Grumpy/Wizard ward states

What needs to be captured

1. Hero GIF (refresh)

Replace .github/assets/wardlume-hero.gif. Should show:

  • Ward activation (menu bar click → overlay appears)
  • silentProfessional default: refracted desktop + corner indicator visible
  • Brief intrusion attempt: corner indicator flashes red
  • Cmd+Shift+W or Touch ID unlock → overlay dissolves cleanly

Target ~10-15 seconds, looping. Show the calm sober-glass aesthetic that v0.2.2 enabled — this is the new visual identity.

2. Touch ID unlock flow GIF

Add .github/assets/wardlume-unlock.gif. Reference already exists in README as commented-out placeholder. Show:

  • Ward active
  • Touch ID prompt appears
  • Authentication succeeds
  • Overlay dissolves

3. Preferences UI screenshot

Static PNG. Show the three asset slots populated with files, pack picker visible, cooldown picker visible. This is the v0.2.0 user customization story made visible.

4. silentProfessional ward state

Static PNG. Show the minimal shader rendering with the corner indicator in the bottom-right. This is the v0.2.2 + v0.2.3 aesthetic — sober, calm, present.

5. Grumpy Old Man ward state

Static PNG. Show the base image (grumpy man) filling the screen during ward, plus a second frame showing the reaction image swap on intrusion.

6. Wizard ward state

Same as #5 but for the Wizard pack.

Capture method

Cmd+Shift+3 is blocked during ward (input lock), so use the timer trick from Terminal:

# For static PNGs
sleep 8 && screencapture -x ~/Desktop/wardlume-{name}.png
# Activate ward within 8 seconds, screencap fires automatically

# For GIFs, use a screen recorder like Kap or LICEcap
# (during ward, run the recording in another tool; capture window will not be blocked)

Where the assets live

.github/assets/ directory. After capturing, commit images alongside README updates that reference them.

TODO comments in README to remove once shipped

Two TODO comments currently in README that should be deleted when this issue closes:

  • <!-- Touch ID Unlock Demo GIF Placeholder --> block near the top
  • <!-- TODO: add screenshots: Preferences UI with three slots, silentProfessional ward with corner indicator, Grumpy/Wizard ward states --> near the Custom Assets section

Acceptance criteria

  • Hero GIF updated to show v0.2.3 visual identity
  • Touch ID unlock GIF added and referenced
  • Three screenshots added: Preferences UI, silentProfessional ward, Grumpy ward, Wizard ward
  • README TODO comments removed
  • All assets committed to .github/assets/ directory
  • Images sized reasonably (compress if large)

Labels

documentation, good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions