Skip to content

docs: professional README, branding & screenshots; migrate build to @crxjs - #10

Merged
drogers0 merged 2 commits into
masterfrom
docs/readme-branding-and-crxjs-build
Jul 1, 2026
Merged

docs: professional README, branding & screenshots; migrate build to @crxjs#10
drogers0 merged 2 commits into
masterfrom
docs/readme-branding-and-crxjs-build

Conversation

@drogers0

@drogers0 drogers0 commented Jul 1, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a professional-grade README and supporting branding/assets, and folds in the in-progress build migration to @crxjs/vite-plugin.

Documentation & branding

  • README.md — hero banner, badges (CI, MIT, MV3, TypeScript, tests), features, synthetic-data screenshots, a horizontal Mermaid architecture diagram in the house palette, a Privacy & permissions section with a per-permission rationale table, Releases-first install (download the prebuilt zip) with build-from-source as a fallback, and development/architecture notes.
  • Branding in the drogers0 house style (navy panel, coral accent, ligature-mono): .github/assets/banner.svg + icon.svg.
  • Extension icon set (icons/16,32,48,128) wired into manifest.json (icons + action.default_icon).
  • Screenshots of the card, popup, and options — all rendered from synthetic holdings/tickers, never real account data (.github/screenshots/).
  • LICENSE (MIT).

Build migration

  • Switch bundling to @crxjs/vite-plugin (single vite.config.ts); content entries renamed to *.iife.ts; manifest references source files.
  • Remove per-target vite configs and the legacy northstar.md.

Verification

  • npm run typecheck
  • npm run lint
  • npm run test ✅ (416 tests)
  • npm run build ✅ (produces dist/ with icons)

Screenshots were captured by driving the real UI modules with synthetic fixtures in headless Chrome — no live Fidelity session was used.

drogers0 added 2 commits July 1, 2026 12:24
…ld to @crxjs

Documentation & branding (primary):
- README.md: hero banner, badges, features, synthetic-data screenshots,
  Mermaid architecture diagram, privacy/permissions table, Releases-first
  install (prebuilt zip) + build-from-source, development/architecture notes
- Branding in drogers0 house style: .github/assets/banner.svg + icon.svg
- Extension icon set (icons/16,32,48,128) wired into manifest.json
- Synthetic-data screenshots (card, popup, options) in .github/screenshots
- LICENSE (MIT)

Build migration:
- Switch bundling to @crxjs/vite-plugin (single vite.config.ts)
- Rename content entries to *.iife.ts; manifest references source files
- Remove per-target vite configs and legacy northstar.md

Verified: typecheck, lint, 416 tests, and full build all pass.
@drogers0
drogers0 merged commit 382ffb5 into master Jul 1, 2026
1 check passed
@drogers0
drogers0 deleted the docs/readme-branding-and-crxjs-build branch July 1, 2026 17:34
drogers0 added a commit that referenced this pull request Jul 1, 2026
…crxjs (#10)

* docs: add professional README, branding, and screenshots; migrate build to @crxjs

Documentation & branding (primary):
- README.md: hero banner, badges, features, synthetic-data screenshots,
  Mermaid architecture diagram, privacy/permissions table, Releases-first
  install (prebuilt zip) + build-from-source, development/architecture notes
- Branding in drogers0 house style: .github/assets/banner.svg + icon.svg
- Extension icon set (icons/16,32,48,128) wired into manifest.json
- Synthetic-data screenshots (card, popup, options) in .github/screenshots
- LICENSE (MIT)

Build migration:
- Switch bundling to @crxjs/vite-plugin (single vite.config.ts)
- Rename content entries to *.iife.ts; manifest references source files
- Remove per-target vite configs and legacy northstar.md

Verified: typecheck, lint, 416 tests, and full build all pass.

* docs: call out Chrome extension near the top; drop em dashes in intro
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