Restructure the README around the reader's path#54
Merged
Conversation
- Fix the tagline: it said macOS and Windows while a whole section documented headless Linux - Document the missing flags (--history, --headless) and point at --help for --version/--config/--db - Group the Usage list by task instead of one flat pile - Move "How Garmin login works" below install and usage; new users hit Cloudflare lore before the install command - Split Install into macOS / Windows / Linux with uv as the lead path - Make Automatic sync platform-neutral with per-OS bullets - Fold the redundant Updating section into Usage (it said the same thing three times) - Merge Credential storage into Security as a per-platform list - Reorder Known quirks: the app-must-process-weigh-in quirk affects everyone, resolution rounding affects few - Drop the Stability table column (every row said Stable) Co-Authored-By: Claude Fable 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.
Full audit of the README against the code, plus a restructure around the reader's path instead of the order sections were written in. No code changes.
Fixes
--historyand--headlessexisted in the CLI but not in the README. Both documented;--version,--config, and--dbget a pointer to--help.--headlesswithout the flag being documented anywhere.Restructure
Left alone on purpose
~/.garmin-sync/naming (renaming breaks installs).Verified against code: weekly update check (
shared.py), diagram filenames, log paths, and the generic platform layer's no-agent behavior.🤖 Generated with Claude Code