README: tighten and restructure#4
Merged
Merged
Conversation
Halves the README (188 → 132 lines) and folds in the storefront-aware keyword adding, chart-position watchdog, and browser-notification plumbing that landed since the last revision. Structural changes: - Folds "Why" into the opening pitch. - Drops the "DMG on the way" note and the inline notarytool/credentials walkthrough — links to .github/RELEASING.md for the release flow. - Drops the project-layout table and the per-stage signing-opt-out prose. `make help` covers what's needed at this level of detail. - Wraps the full endpoint table in <details> so the API section reads as a 5-bullet category list by default. Adds the 4 new chart routes. - Updates the architecture ASCII to show both daily scheduled jobs (keyword refresh + chart watchdog) and the RSS feed + SPA-poll → Notification API path. - Replaces "push/email alerts" in 'What's not here' with the actual next missing piece (chart-position history / sparklines). - Fixes a stale path: KeywordScorer.swift lives in Sources/App/Domain/, not Services/. CI: the paths-ignore rule from PR #3 means this README-only PR triggers no pipeline — first real exercise of the skip rule.
A picture beats four lines of architectural prose for 'what does this actually look like'. Sourced from a live local run with 30 tracked keywords spread across US/GB/DE/JP/IN/FR — shows ranks, top-result icon strips, difficulty + entry-barrier dots, and the country picker that landed in #1. Lives at docs/dashboard.png so we have a directory to drop more screenshots into later (charts page, history panel, etc.) without cluttering the repo root.
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.
Summary
Halves the README (188 → 132 lines) and folds in the storefront-aware keyword adding, chart-position watchdog, and browser-notification plumbing that landed in PRs #1 and #2 since the last revision.
What changed
Whyinto the opening pitch. One paragraph now covers the value prop instead of an intro + a separate "Why" section.NotificationAPI path.<details>. The five categories (apps / keywords / dashboard / charts / settings) remain visible by default; the 19-row table opens on click. Adds the 4 new chart endpoints:GET /chart-positions,GET /chart-events,POST /charts/refresh,POST /apps/:id/availability/refresh..github/RELEASING.md. The README no longer carries anotarytool store-credentialswalkthrough or per-stage signing opt-out prose — that's contributor reference, not "should I use this?" material.What's not herenow lists chart-position history / sparklines (the actual v2 follow-up) instead of push/email alerts — which are partially in for chart events via the browser-notification path.KeywordScorer.swiftlives inSources/App/Domain/, notServices/.Verification
wc -l README.md→ 132 (target was 90-110; slightly over because the diagram alone is 28 lines, but the prose is the targeted half).LICENSE,CONTRIBUTING.md,SECURITY.md,.github/RELEASING.md,web/src/lib/countries.ts,Sources/App/Services/AvailabilityProber.swift,Sources/App/Services/ChartTrackerService.swift,Sources/App/Domain/KeywordScorer.swift,requests.http.Sources/App/Controllers/ChartsController.swift'sroutes.get/routes.postcalls.CI
First real exercise of PR #3's
paths-ignorerule — this README-only PR should trigger no pipeline at all.