Skip to content

docs: rewrite README for new contributors - #32

Merged
dsatpm merged 1 commit into
mainfrom
dsatpm/readme-refresh-c609103e
Oct 10, 2026
Merged

dsatpm merged 1 commit into
mainfrom
dsatpm/readme-refresh-c609103e

Conversation

@dsatpm

@dsatpm dsatpm commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

What changed

Rewrote README.md in plain, friendly language for an open source audience:

  • Removed npm/test command lists (they're in package.json).
  • Kept only project-specific facts: spec as source of truth, dev build required (Expo Go can't load ClockSnapshot), generated ios//android/, two-clock timing rule, no-delete corrections, Android release builds without INTERNET, Emergency demo mode env vars, iOS UIScene setting, privacy policy and palette tests, code layout, CI, license.

How it was tested

Docs only. Checked each claim against the source (src/domain/emergency.ts, src/platform/phone.ts, plugins/, app.json, tests/palette.test.ts, tests/privacyPolicy.test.ts, .eas/workflows/pr-builds.yml) and fetched both external links (privacy page title, expo/fyi page).

🤖 Generated with Claude Code

Drop the npm command lists (package.json has them) and keep only what a
new developer can't learn elsewhere: the spec, the dev-build requirement,
generated native folders, the two-clock rule, Android release builds
without INTERNET, the Emergency demo mode, iOS UIScene support, the
privacy policy and palette tests, and where code lives.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dsatpm
dsatpm merged commit 1b33217 into main Oct 10, 2026
1 of 3 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