docs(readme): web-first framing + standalone HTML build path #90

Merged

forgejo_admin merged 1 commit from docs/readme-web-first into master

2026-05-14 03:06:19 +00:00

forgejo_admin commented

2026-05-14 03:00:53 +00:00

Owner

Summary

Brings the README in line with the v5 codebase and the modernization-roadmap.md web-only direction. The previous README still framed ExifCleaner as a desktop app first — "Desktop app + browser webapp" tagline, a "Download and Install" section linking to upstream szTheory/exifcleaner .dmg / .exe / .AppImage from v3.6.0 (May 2021, pre-Phase-D).

Changes

Tagline → "Runs entirely in your browser — no uploads, no server."
Features list → drops the cross-platform line; leads with "Browser-based: install as a PWA or run from a single self-contained HTML file." Also corrects the privacy-controls line — Phase F #83 enforces epoch timestamps, there is no "preserve timestamps" setting (per privacy-invariants.md §6).
Remove "Download and Install" entirely — the upstream desktop links pointed at the legacy v3.6.0 binaries (last released May 2021); they don't reflect the v5 codebase, and sending users there is misleading.
"Running the web app locally" gets a new Option 1: Single-file HTML via yarn build:web:standalone (lands in docs/standalone-html.md, shipped in #89). Docker / Node dev server / build+preview shift to Options 2–4.
Drop the screenshot — static/screenshot.png pre-dated the BEFORE/AFTER/RESULT columns (#88) and the overall v5 UI. File deleted; reference removed. A fresh screenshot is a separate task with its own decisions (mode, sample files, platform chrome).

Out of scope (deliberately not in this PR)

New screenshot — separate task.
Touching the "Development" section. yarn dev still launches Electron and that path is functional until Phase G ships; the README's dev instructions match the current dev workflow even if they downplay the Web-first direction.
Editing CLAUDE.md, project-direction.md, or modernization-roadmap.md. Those are internal docs for contributors and Claude; reframing them is a larger swing.

Test plan

yarn lint (prettier) passes on README.md
Reviewer eyeballs the rendered README in Forgejo's preview to confirm the option ordering and section flow read cleanly
No broken intra-repo links (docs/standalone-html.md and the other doc paths all exist)

🤖 Generated with Claude Code

## Summary Brings the README in line with the v5 codebase and the [`modernization-roadmap.md`](.claude/rules/modernization-roadmap.md) web-only direction. The previous README still framed ExifCleaner as a desktop app first — "Desktop app + browser webapp" tagline, a "Download and Install" section linking to upstream `szTheory/exifcleaner` .dmg / .exe / .AppImage from v3.6.0 (May 2021, pre-Phase-D). ## Changes - **Tagline** → "Runs entirely in your browser — no uploads, no server." - **Features list** → drops the cross-platform line; leads with "Browser-based: install as a PWA or run from a single self-contained HTML file." Also corrects the privacy-controls line — Phase F #83 enforces epoch timestamps, there is no "preserve timestamps" setting (per [`privacy-invariants.md`](.claude/rules/privacy-invariants.md) §6). - **Remove "Download and Install" entirely** — the upstream desktop links pointed at the legacy v3.6.0 binaries (last released May 2021); they don't reflect the v5 codebase, and sending users there is misleading. - **"Running the web app locally"** gets a new **Option 1: Single-file HTML** via `yarn build:web:standalone` (lands in [docs/standalone-html.md](docs/standalone-html.md), shipped in #89). Docker / Node dev server / build+preview shift to Options 2–4. - **Drop the screenshot** — `static/screenshot.png` pre-dated the BEFORE/AFTER/RESULT columns (#88) and the overall v5 UI. File deleted; reference removed. A fresh screenshot is a separate task with its own decisions (mode, sample files, platform chrome). ## Out of scope (deliberately not in this PR) - New screenshot — separate task. - Touching the "Development" section. `yarn dev` still launches Electron and that path is functional until Phase G ships; the README's dev instructions match the current dev workflow even if they downplay the Web-first direction. - Editing `CLAUDE.md`, `project-direction.md`, or `modernization-roadmap.md`. Those are internal docs for contributors and Claude; reframing them is a larger swing. ## Test plan - [x] `yarn lint` (prettier) passes on README.md - [ ] Reviewer eyeballs the rendered README in Forgejo's preview to confirm the option ordering and section flow read cleanly - [ ] No broken intra-repo links (docs/standalone-html.md and the other doc paths all exist) 🤖 Generated with [Claude Code](https://claude.com/claude-code)

forgejo_admin added 1 commit 2026-05-14 03:00:54 +00:00

docs(readme): web-first framing + standalone HTML build path

CI / Lint, Typecheck & Unit Tests (pull_request) Successful in 2m41s

Details

CI / E2E (Standalone single-file) (pull_request) Successful in 13m15s

Details

CI / E2E (Web) (pull_request) Successful in 21m0s

Details

2e60d66222

The README still described ExifCleaner as a desktop app first ("Desktop
app + browser webapp" tagline, "Download and Install" section linking
to .dmg / .exe / .AppImage from the upstream szTheory/exifcleaner
GitHub releases). After Phase D's convergence on a single processing
engine and the modernization-roadmap.md commitment to web-only
distribution (Phase G), that framing is stale — the deployed PWA and
the new standalone single-file HTML build are the primary user-facing
paths now.

Changes:

  - Tagline → web-first: "Runs entirely in your browser — no uploads,
    no server."
  - Features list: drop the cross-platform line; lead with
    "Browser-based: install as a PWA or run from a single
    self-contained HTML file." Also correct the privacy-controls line
    — Phase F #83 enforces epoch timestamps (no "preserve timestamps"
    setting per privacy-invariants.md §6).
  - Remove the "Download and Install" section entirely. The upstream
    desktop releases linked from there are the legacy v3.6.0 binaries
    (last released May 2021); they don't reflect the v5 codebase and
    sending users to them is misleading.
  - "Running the web app locally" gets a new Option 1: standalone
    single-file HTML via `yarn build:web:standalone`. Docker, Node dev
    server, and build+preview shift to Options 2–4.
  - Drop the static/screenshot.png reference + delete the file. The
    screenshot pre-dated the BEFORE/AFTER/RESULT columns (#88) and the
    overall v5 UI. A fresh one is a separate task.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>