Skip to content

Polish repository presentation - #1

Merged
YKKULTRA merged 1 commit into
mainfrom
agent/repository-polish
Jul 14, 2026
Merged

Polish repository presentation#1
YKKULTRA merged 1 commit into
mainfrom
agent/repository-polish

Conversation

@YKKULTRA

Copy link
Copy Markdown
Owner

What changed

  • redesigned the README around SqueakyClean's evidence-first value proposition
  • added a real dark-mode app screenshot, status badges, a scope table, an honest quick start, and a concise FAQ
  • moved the detailed cleanup invariants and trust boundaries into Docs/SAFETY.md
  • kept the current limits prominent: only dead user LaunchAgents are actionable, quarantine does not itself reclaim space, and public builds are not yet notarized

Why

The original README was technically thorough but read like internal engineering documentation. This makes the repository easier to understand at a glance without weakening or overstating the safety story.

User and developer impact

Visitors now get a clearer product overview, a real look at the UI, accurate build instructions, and a direct path to the full safety model. The app code and runtime behavior are unchanged.

Validation

  • GitHub Markdown API rendered the README successfully
  • all local README links resolve
  • workflow and badge URLs return HTTP 200
  • git diff --check passes
  • screenshot verified as a 1312 x 884 PNG
  • existing main CI is green

@YKKULTRA
YKKULTRA marked this pull request as ready for review July 14, 2026 20:06
@YKKULTRA
YKKULTRA merged commit c14ab75 into main Jul 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant