Repository navigation
docs(readme): lead with what a visitor needs, developers last - #69
Merged
Merged
Conversation
The README carried the hook examples, the status file path and the credit, and this page carried the setup. They are one page now, so the README can point here in a line. The per-agent list is a table, and the accepted verbs match agent-hook.js (writing and running were missing).
The page made someone who only wanted the pet read past git clone, a code-signing essay and a section of shell commands for coding agents. The order is now: what it is, how to get it, what it does, the everyday tools, coats, is it safe, then a developer section. - Quick Tools moves up and opens with the ? command. A note says it, the eight languages and Focus Guard came after v0.4.0 and are not in the download yet. - Privacy becomes Is it safe?, with the answer in four sentences and the detail folded below. - The coding agent section moves to integrations/ and leaves a link. - Start at login: the README offered npm run autostart:off, which is no use to someone who ran the installer. It now names the Windows and macOS settings that control it. - The tray row was a 30 item sentence. It is four words.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
CI for 2eed9aa: all jobs passed
Tests: 507 passed, 0 failed, 0 skipped, 507 total. This comment updates itself on every push. Full run. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Reorders the README for someone who wants the pet, not the source. Nothing about the app changes.
git cloneblock?integrations/Things worth checking
npm run autostart:off. There is no in-app switch, so the README now names the OS settings (Windows Startup apps, macOS Login Items).integrations/README.mdnow listswritingandrunningas accepted verbs, matchingagent-hook.js.Test plan
npm test: 503 pass, 0 fail, 4 skipped (POSIX only).tests/bridge-paths.test.jsstill finds the bridge paths documented.npx eslint .clean