Restructure the README to the portfolio standard - #4
Merged
Conversation
Reorders the README into the standard product layout (hero, badges,
disclosure, overview, what it does, get it, contributing, licence) and
corrects several claims that the source contradicts.
Removed or corrected:
- The Install section told readers to download ClaudeWatch.zip from the
Releases page. No release has ever been published, so there was nothing
to download. Replaced with build-from-source instructions, stated
plainly as the only way to get it today.
- The release badge rendered "no releases or repo not found" for the same
reason; dropped until a release exists.
- "makes no network connections" and "No telemetry, no network, no data
leaves your machine" were both wrong. Sources/ClaudeWatch/Updater.swift
starts Sparkle's updater at launch against the SUFeedURL that build.sh
writes into Info.plist, and NotificationEngine posts to user-configured
Discord/Slack/Teams/generic webhooks over URLSession. The overview now
says it never writes to your transcripts and has no telemetry, and names
the two network paths.
- The signed-and-notarised release note described a path that has never
run; only the unsigned first-launch caveat remains.
- "Two icons appear in your menu bar" was unconditional. One item appears
per source that actually has transcripts, per SourceAvailability and
isVisible(_:).
Added, all verified against the source: the Codex event kinds
(exec_command, write_stdin, apply_patch), the active-sessions strip and
bell icon, and the notification rules and Keychain-backed webhooks, none
of which the README mentioned.
Moved out of the README rather than deleted, into a new CONTRIBUTING.md:
the project layout, the --dump and --render-test headless modes, the
justfile recipes, what CI actually runs, and how the tag-triggered release
job behaves.
Badges are now status, CI and licence. The CI badge resolves ("passing")
because build.yml runs on pushes to main; the licence badge resolves
("MIT") because LICENSE exists.
4624 -> 5060 bytes.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
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.
Brings the README into the portfolio-wide layout: hero, badge row, disclosure block, rule, overview,
## What it does,## Get it,## Contributing,## Licence. The existing voice and the accurate prose are kept — this is a restructure plus a correctness pass, not a rewrite.Wrong facts removed
ClaudeWatch.zipfrom the Releases page, unzip, and drag to/Applications.gh release listis empty and there are no tags, so there has never been anything on that page. Replaced with build-from-source instructions and a plain statement that there is no packaged download and no Homebrew formula yet.https://img.shields.io/github/v/release/adamXbot/ClaudeWatchreturnsrelease: no releases or repo not found. Dropped until a non-prerelease release exists.Sources/ClaudeWatch/Updater.swiftconstructsSPUStandardUpdaterController(startingUpdater: true, …), so Sparkle begins its scheduled-update lifecycle at launch against theSUFeedURLthatbuild.shwrites intoInfo.plist.NotificationEngineholds aURLSessionand posts to user-configured Discord, Slack, Teams and generic-JSON webhooks. The overview now says what is actually true: it never writes to your transcripts and there is no telemetry, and it names both network paths.releasejob inbuild.ymlonly fires on av*tag, and no tag exists. Only the unsigned first-launch caveat is kept.SourceAvailabilityandisVisible(_:), one menu-bar item appears per source that actually has transcripts, with a manual show/hide override in Settings.No dead relative paths were found in the old README; every path and URL in the new README and CONTRIBUTING.md was checked (
test -efor paths,curlfor URLs) and returns < 400, with the one exception noted at the bottom.Real content that was missing
Added from the source, not invented: the Codex event kinds (
exec_command,write_stdin,apply_patch), the active-sessions strip and the bell menu-bar icon when a session is waiting, and the notification rules with Keychain-stored webhook URLs. None of these were documented.Content moved, not deleted
New
CONTRIBUTING.mdtakes the project layout, the--dumpand--render-testheadless modes, thejustfilerecipes, what CI genuinely runs, and how the tag-triggered release job degrades when signing secrets are absent.Badges
Status, CI, licence. The CI badge resolves to
passing—build.ymlruns on pushes tomainand there are successful runs there. The licence badge resolves toMIT—LICENSEexists.Size
README 4624 -> 5060 bytes, under the ~6 KB target. Plus 3378 bytes of moved content in
CONTRIBUTING.md.Known, expected
The status badge renders "resource not found" and its
STATUS.mdlink 404s until the status hub PR merges inadamXbot/.github. The endpoint path is correct and will resolve then.Separately, and out of scope for this PR:
build.shandbuild.ymlboth point maintainers at aRELEASING.mdthat does not exist in the repo.