Skip to content

docs: the README opens with a real Claude Code session - #106

Merged
alkhatibdev merged 1 commit into
mainfrom
readme-gif
Nov 18, 2026
Merged

alkhatibdev merged 1 commit into
mainfrom
readme-gif

Conversation

@alkhatibdev

Copy link
Copy Markdown
Owner

The README opens with a real Claude Code session

  • A GIF under the links: Claude Code 2.1.327 with the DPOLens plugin, asked to "Log failed
    logins with the email that was tried and the client IP, so we can spot credential stuffing."
    It checks the policy first, calls DPOLens (its query: "logging IP addresses and attempted email
    addresses of failed logins for security monitoring"), writes a maskEmail helper under the
    comment // Policy sample-data-protection:6.1: email addresses in logs are masked., and ends by
    quoting the clause, "Email addresses and phone numbers in logs are masked", with its key,
    version and date.
  • The three DPOLens moments are highlighted: the search, the code that cites the clause, and the
    answer that quotes it. For about 3 seconds each, the rest of the window darkens, the block
    lifts, and one line at the foot of the window says what is happening ("Claude Code asks DPOLens
    before it writes the code", "The new code cites the clause it follows", "The answer quotes the
    clause, with its key"). Between them the session plays as Claude Code shows it.
  • Under it, one line says it is a real session on the sample policy every new instance starts
    with, and that the highlights are added and the waits shortened.
  • The community version's one-click links move up, right under the GIF, so a reader can try it
    at once. Get started keeps the self-hosted paragraph.

How the GIF was made

  • Recorded in the trigger test's run container: the Larder app, Claude Code installed from npm,
    the plugin installed from this repository's marketplace, a throwaway instance built from
    97a056d, Claude Sonnet 5.5. Three takes were recorded; all three called DPOLens before their
    first edit, masked the email and quoted clause 6.1. This is the one whose answer reads best.
  • Every frame is the session's own, in its own order. Waits where only the spinner moved are
    shortened, the typing plays twice as fast, and the screens to read are held longer: 41 seconds
    of session in 20, then the answer for 9. The highlights are drawn over the frames afterwards.
  • Drawn at twice its width in the README (1840 by 1481, set to 920 wide), so it stays sharp on
    high-density screens: 6.2 MB. Its window is the site hero's, the caption is the site's tag, and
    the corners are transparent.

Checked

  • Rendered through GitHub's Markdown API and looked at in Chromium, 1280 wide in light and dark
    and 390 wide: the GIF fills the README's width and sits on both grounds; nothing scrolls
    sideways. On a phone it is to be opened for reading, as any terminal recording is.
  • Every frame compared with its neighbours: no frame flashes a half-drawn screen.
  • tests/unit/test_client_files.py, the one test that reads the README: 52 passed.

Signed-off-by: alkhatibdev <me@alkhatib.dev>
@alkhatibdev
alkhatibdev merged commit c3a6f3a into main Nov 18, 2026
4 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