Skip to content

README: lead with what it solves and the two ways to drive it - #12

Merged
max1874 merged 6 commits into
mainfrom
max/readme
Nov 9, 2026
Merged

max1874 merged 6 commits into
mainfrom
max/readme

Conversation

@max1874

@max1874 max1874 commented Nov 5, 2026 •

Copy link
Copy Markdown
Owner

Why

The README opened with built-in-agent setup and a paid backend, and its hero was a Calculator GIF. A new reader could not tell what the project solves, or how to start without a key.

What

  • Hero: docs/demo.gif (X-ray direction, chosen by Max on 2026-11-08). It is replayed from one real observe / act on System Settings › Appearance: the indices, labels, states and the delivered · took_focus false result are the tool's own output, and the window geometry is drawn. No capture of the maintainer's desktop. The caption says the run predates the --machine-wide gate.
  • Opening: a tagline, then a problem → what-happens-here table and a diagram of the observe → guarded act → observe loop.
  • "Drive it from a coding agent": install, permission check, and the real output of a background TextEdit run (TYPE_TEXT → delivered_verified), plus exit codes.
  • "Or give the built-in agent a goal": uv sync --extra agent, .env, Python verify / focus_check, risk approval and the inspector. Rarer backend settings are folded into <details>.
  • Operations, guarantees, limits and verification as tables and lists, including Keep native CLI independent and stop on focus violations #13's protocol and focus-violation facts and Refuse whole-Mac changes in System Settings unless the user allowed them #14's System Settings gate.
  • DESIGN.md records the presentation verdicts.

Acceptance

Rendered on GitHub from this branch head (screenshots kept in the maintainer's local acceptance folder). Docs only; CI runs unchanged.

🤖 Generated with Claude Code

max1874 and others added 4 commits November 8, 2026 23:33
Problem table, a diagram of the loop, coding-agent setup with real output,
then the built-in agent, operations, guarantees and limits as tables and
lists. No behaviour claims were added or dropped.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…achine-wide gate

The Calculator GIF and sample output are replaced. The hero is drawn from one
real observe/act on System Settings > Appearance; no capture of the
maintainer's desktop. DESIGN.md records the verdicts behind it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
max1874 and others added 2 commits November 8, 2026 23:38
… fades

GitHub and reduced-motion readers see the first frame; it was black.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@max1874
max1874 merged commit 51bfdb6 into main Nov 9, 2026
2 checks passed
@max1874
max1874 deleted the max/readme branch November 9, 2026 05:49
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