Skip to content

docs: add project logo to the README (theme-aware) - #15

Merged
maxie7 merged 1 commit into
mainfrom
docs/logo
Jul 25, 2026
Merged

docs: add project logo to the README (theme-aware)#15
maxie7 merged 1 commit into
mainfrom
docs/logo

Conversation

@maxie7

@maxie7 maxie7 commented Jul 25, 2026

Copy link
Copy Markdown
Owner

Adds the logscry logo to the top of the README. Closes #6.

What

A centered horizontal lockup (an eye "scrying" over two log lines — the second stops short, since most of the stream never gets reported) sits above the title.

Theme-aware, not a single image

The source docs/logo.svg draws its strokes with currentColor. GitHub renders README images via <img>, which doesn't inherit page CSS, so currentColor collapses to black — fine in light mode, near-invisible in dark mode, where most developers read. So instead of one image:

  • docs/logo-light.svg — dark strokes (#1c2933) for light backgrounds
  • docs/logo-dark.svg — light strokes (#e6edf3, GitHub's dark-mode text color) for dark backgrounds
  • the teal accent (#12A594) is unchanged in both, since it reads on either background

Both are mechanically derived from logo.svg — only the four currentColor tokens were swapped, no geometry touched. The README uses a <picture> element so GitHub serves the right one per theme:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="docs/logo-dark.svg">
  <img src="docs/logo-light.svg" alt="logscry" width="440">
</picture>

The # logscry heading stays below the image for accessibility and anchor links.

Also

  • docs/logo.svg (the currentColor original) and docs/logo-mark.svg (a square mark, for a future favicon / landing page — Publish a simple landing page on GitHub Pages #9) are committed but not referenced from the README.
  • Dropped a stale line in CLAUDE.md that claimed the repo is private until M6 — it's public. Kept the secrets guidance.

No code touched.

Wire the logo into README.md: a centered horizontal lockup above the
title, served per color scheme via <picture> so it stays visible in
both GitHub light and dark mode (the currentColor original collapses to
near-invisible black on dark backgrounds when loaded via <img>).

- docs/logo.svg: original lockup (currentColor), kept as the source
- docs/logo-light.svg / docs/logo-dark.svg: color variants derived by a
  mechanical stroke/fill swap (teal accent unchanged), for light/dark bg
- docs/logo-mark.svg: square mark, for favicon / landing page (not
  referenced from the README)
- CLAUDE.md: drop the stale "PRIVATE until M6" claim; repo is public

Closes #6

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@maxie7
maxie7 merged commit 1ec554f into main Jul 25, 2026
1 check passed
@maxie7 maxie7 self-assigned this Jul 25, 2026
@maxie7
maxie7 deleted the docs/logo branch July 25, 2026 19:12
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.

Add a project logo and use it in the README

1 participant