Skip to content

Screenshots or short recordings for the tool READMEs #3

Open

Description

@nrzz

Most tool READMEs are text only. A picture of the thing working helps people decide in seconds, and no code is needed to add one:

  • Glow: the status line and the HUD in a terminal (docs/themes.svg already shows the themes).
  • Guardrails: Claude Code stopping rm -rf / with the reason.
  • Notify: a desktop or phone notification.
  • Cost guard: the 80% warning line, and a hard stop.
  • CLAUDE.md doctor: the report in a terminal.
  • Session replay: docs/example.html exists; a screenshot of it in the README would help.
  • Team sync: the session-start digest with a teammate's news.

How: put images in the tool's docs/ folder (PNG or SVG, under 500 KB, no personal paths or secrets visible), and add them to that tool's README under the intro. One pull request per tool repository is ideal. Comment here with the one you are taking.

Activity

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

    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