[b3hr4d]

What

The README was 292 lines of design notes, setup, operations and history. It is now an 82-line page for someone meeting B3Note: the logo, a tagline, a link to the app, badges, a screenshot that follows the reader's light or dark theme, six features, one paragraph on how the encryption works, four commands to run it locally, and links to the rest.

Preview the README on this branch

Changes

• README.md: rewritten as above, and no longer marked executable (GitHub labelled it "Executable File").
• Nothing is dropped. The old sections move, with their text unchanged except where noted, to:
  • docs/how-it-works.md: the encryption design and what the canister sees.
  • docs/development.md: layout, getting started, the frontend on ic-reactor 4, the AI locally, tests. Adds that the PocketIC binary must be named pocket-ic (the server refuses any other name).
  • docs/operations.md: deploying (fix(deploy): record production's canister ids, and never create on mainnet #15's text), limits and settings, the custom domain. It no longer says the domain works "once the steps below are done".
  • docs/v2.md: what v2 fixes, and upgrading from v1.
• docs/images/app-light.png and app-dark.png (2560x1600, 256 colours, about 120 KB each).
• Comments that cited README sections (origins.ts, Markdown.tsx, .ic-assets.json5, two tests, icp.yaml, migrate-mainnet.sh) now cite the docs pages.

Evidence

• Fact: the screenshots are of this branch's app on a local PocketIC backend (pnpm dev:pocketic with PocketIC 16.0.0, whose download matched the digest candid-profile pins), signed in as a guest with five sample notes. Nothing touched mainnet.
• Fact: GitHub renders the page as intended in light and dark mode (checked in Chromium on the branch's README): the logo and the screenshot switch with the theme, and the badges and links resolve.
• Fact: the README's feature and design claims were checked against the old README and the app: share links need Internet Identity, the guest key lives in the browser, and the shared copy is deleted after the last view.
• pnpm format:check, pnpm typecheck and pnpm test (61 tests) pass, and git diff --check is clean.
• Open: the repository's About text on GitHub still describes v1 ("similar to Witness Encryption"); only an admin can change it.

---

Generated by Claude Code