Skip to content

docs: branded README banner + presentation polish - #21

Merged
kbennett2000 merged 1 commit into
mainfrom
chore/readme-banner-polish
Jun 22, 2026
Merged

docs: branded README banner + presentation polish#21
kbennett2000 merged 1 commit into
mainfrom
chore/readme-banner-polish

Conversation

@kbennett2000

Copy link
Copy Markdown
Owner

What

Presentation polish to make the repo look world-class at a glance. No app code, resources, or frozen-core files touched.

Banner

  • New assets/banner.svg (source of truth) + assets/banner.png (2560×640, rendered at 2x).
  • Brand-bar design: white open-book glyph on amber #FF8F00, reusing the exact book <path> from the app's adaptive icon (ic_launcher_foreground.xml) so the banner reads as the app.

README

  • Banner at the top + a badge row (License Apache-2.0, Android, SDK 29–36, OCR engines, on-device, CI build).
  • A quick-reference Features table (capture → OCR → combined text → anchor → edit → verse-span fill → finalize → privacy).
  • Scannable section headings and links to the existing CONTRIBUTING / CODE_OF_CONDUCT / SECURITY / AI_POLICY docs (previously unlinked).
  • Fixed stale first-run text: bearer token → username + password (cookie-session auth, per the F6b errata in CLAUDE.md).

Repo metadata (applied directly via gh, not part of this diff)

  • Description rewritten.
  • 17 topics added: android, ocr, paddleocr, opencv, onnxruntime, on-device, camerax, document-scanner, document-scanning, bible, scripture, sermon, sermon-notes, self-hosted, privacy, java, apache-2-0.

Verify

  • assets/banner.png: 2560×640, amber field, legible wordmark/taglines.
  • README renders with banner, badges, and feature table.

🤖 Generated with Claude Code

Add an on-brand README banner (white open-book glyph on amber #FF8F00,
matching the app's adaptive icon) authored as assets/banner.svg and
rendered to assets/banner.png at 2x.

Restructure README.md: banner + status/SDK/OCR/CI badges, a quick-reference
feature table, scannable section headings, and links to the existing
CONTRIBUTING / CODE_OF_CONDUCT / SECURITY / AI_POLICY docs. Correct the
stale "bearer token" first-run text to username + password (cookie-session
auth, per the F6b errata).

Presentation only — no app code, resources, or frozen-core files touched.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@kbennett2000
kbennett2000 force-pushed the chore/readme-banner-polish branch from 6f56cdf to 124e16e Compare June 22, 2026 19:27
@kbennett2000
kbennett2000 merged commit ee116ec into main Jun 22, 2026
2 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