Restructure the README to the portfolio standard - #7
Open
adamXbot wants to merge 1 commit into
Open
Conversation
Reorders the README into the shared product layout (hero, badges, disclosure, overview, what it does, get it, docs, contributing, licence) and moves the contributor-facing detail into named files. Corrections: - "clean hourly, daily, or on-demand" was wrong. ScheduleInterval offers 1, 2, 4, 8, 12 and 24 hours, or manual only. - The feature list omitted the dry run, the self-test, the snapshot, the PathSafety guardrails and the unattended-run downgrade, all of which exist in the source. - Target counts are now stated from the registry: 8 basic, 10 strong, 8 paranoid, 26 total. - Added a note that the Homebrew tap is serving 0.0.2 while the latest release is v0.0.3, rather than implying the cask is current. - "License"/"behavior" -> "Licence"/"behaviour" for consistency with the rest of the portfolio. Moved out of the README (nothing deleted): - build requirements, XcodeGen usage, the test command and coverage table, the just recipes and the script inventory -> CONTRIBUTING.md - reverting, recovery-script regeneration, snapshots and the Full Disk Access requirement -> docs/RECOVERY.md - the manual Finder locking walkthrough and its image -> docs/MANUAL-LOCKING.md - the "Cutting a release" and Sparkle setup sections, which duplicated docs/RELEASES.md, are now a link to it The destructive-operations CAUTION is kept verbatim as a separate block below the disclosure; it makes a different claim and is not merged in. Badges: status, release, licence and CI. All four URLs were checked; release, licence and CI resolve. README 5716 -> 6365 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 this README into line with the layout every other repo in the portfolio is moving to: hero, badge row, disclosure block, then overview / what it does / get it / docs / contributing / licence.
Wrong facts removed
ScheduleIntervaloffers every 1, 2, 4, 8, 12 or 24 hours, or manual only. Corrected.## Installsection implied the Homebrew cask is current. It is not:adamxbot/homebrew-tapis serving 0.0.2 while the latest release here is v0.0.3. The README still points at the tap as the normal install path, but now says so plainly so nobody wonders why they got an old build.DryRun.swift), the self-test (SelfTest.swift), the pre-clean APFS snapshot (SnapshotService.swift), thePathSafetyguardrails, and the fact that unattended scheduled runs downgrade "Lock with Immutable File" to a plain wipe unlessallowAggressiveScheduledCleanis on. All added, all verified against source.MARKETING_VERSIONinproject.ymlreads 1.0.1, which does not match any published release. Nothing in the new README claims 1.0 — the disclosure uses the pre-1.0 variant, matching the actual latest release of v0.0.3. Worth fixing inproject.ymlseparately; the release workflow will refuse to publish a tag that disagrees with it.## Cutting a releaseand## Auto-updates (Sparkle)sections, which duplicateddocs/RELEASES.mdand had begun to drift from it. The README now links there instead, and states accurately that Sparkle is dormant (SUFeedURLandSUPublicEDKeyare absent fromInfo.plist, there is nogh-pagesbranch, andhttps://adamxbot.github.io/BananaBlitz/appcast.xmlcurrently 404s — so that URL is deliberately not linked from the README).Links
Every link in the new files was checked. All relative paths exist; every external URL returns 200, including the
user-attachmentsscreenshot, which was preserved and moved rather than dropped.Badges
Status, release, licence and CI. Release renders
v0.0.3, licence rendersMIT, and CI renderspassing—ci.ymldoes run on pushes tomainand has runs there. The status badge renders "resource not found" until the status hub PR merges; the path is correct and it will resolve then.Content moved, not deleted
justrecipes and the bundled-script inventory → newCONTRIBUTING.mddocs/RECOVERY.mddocs/MANUAL-LOCKING.mdThe destructive-operations
[!CAUTION]block is kept verbatim as a separate block below the disclosure. It makes a different claim from the stability warning and has not been merged into it.Size
README 5716 → 6365 bytes.