Skip to content

Launch 2/5: README hero, screenshots, GIF, badges, topics, social preview #201

Closed

Description

@MehdiMamas

Part of #199.

Real screenshots (desktop size, light and dark) from the app or the browser UI with the fake backend (pnpm -C app/ui dev), a short demo GIF, what/install/how it works, shields.io badges (release, CI, license, downloads, platforms), topics, social preview image (1280x640). Study PassBridge README. Acceptance: README renders on GitHub with images; topics set.

Activity

  1. MehdiMamas commented on Nov 14, 2026

    @MehdiMamas
    OwnerAuthor

    Plan

    • Capture real screenshots of the UI (fake backend, pnpm -C app/ui dev) at desktop size in light and dark into docs/images/, plus a short demo GIF.
    • Rewrite the README top: centered logo, title, one-line pitch, shields.io badges (release, CI, license, downloads, platforms), demo GIF, screenshots, a short 'What you get' and 'How it works', keep the existing Install and Use sections.
    • Add a 1280x640 social preview image at docs/images/social-preview.png (GitHub's upload step for it is web-only).
    • Set repository topics.
      Edge cases: README images use repo-relative paths and render on GitHub; screenshots hold only fake data; images are small; topics set and verified.
      ETA: about 30 minutes
  2. MehdiMamas commented on Nov 14, 2026

    @MehdiMamas
    OwnerAuthor

    Checkpoint: PR #215 (commit 694f6c0) holds the README hero, badges, light and dark screenshots, demo GIF and social preview image. Topics are set. Image URLs on the branch load (HTTP 200). CI is running; merge follows when it passes. Left for the owner: upload docs/images/social-preview.png under repo Settings, Social preview (no API). Note: #203 also edits README badges, so whichever merges second rebases.
    ETA: about 10 minutes (CI)

  3. MehdiMamas commented on Nov 14, 2026

    @MehdiMamas
    OwnerAuthor

    Checkpoint: PR 215 merged (264558b). README hero, badges, screenshots, GIF and social preview are on main; topics set. Left for the owner: upload docs/images/social-preview.png under Settings, Social preview.
    ETA: done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions