Skip to content

Rewrite README as a developer hub, add MIT LICENSE and brand assets - #3

Merged
alexbaldwin merged 6 commits into
mainfrom
alexbaldwin/readme-developer-hub
Jul 6, 2026
Merged

Rewrite README as a developer hub, add MIT LICENSE and brand assets#3
alexbaldwin merged 6 commits into
mainfrom
alexbaldwin/readme-developer-hub

Conversation

@alexbaldwin

Copy link
Copy Markdown
Contributor

What changed

Turns the stale 25-line README into a full developer hub for the logo.dev API, modeled on the Resend/firecrawl repo shape:

  • README rewrite — hero banner, stat strip (canonical numbers from lib/stats.ts), the one-<img>-tag hook, "Why logo.dev", endpoint table, multi-language quickstart (HTML / React / cURL / Python inline, rest linked to docs), Clearbit migration section with the Alex MacCaw testimonial, "use logo.dev logos in your own README" + free-tier attribution guidance, FAQ, and resources.
  • LICENSE — MIT (gates the license badge and GitHub's license widget).
  • assets/hero-banner.svg — monochrome hero banner (wordmark + tagline + stat line, per DESIGN.md).
  • assets/powered-by-logo-dev.svg — the previously-missing "Powered by Logo.dev" attribution badge for free-tier users.

Why

This repo is the GitHub front door for the API and the target for "logo api" searches on GitHub. The old README pointed elsewhere and carried no LICENSE. The rewrite gives developers a copy-paste path to a first logo, claims the Clearbit-migration story ("same team that built the original Clearbit Logo API"), and pairs with repo-metadata updates (About + topics, incl. the missing logo-api topic — done separately in repo settings).

Reviewer notes

  • Multi-agent review ran clean (correctness / security / maintainability): stats, attribution snippet, Clearbit shutdown date, and the MacCaw quote all verified against the canonical marketing sources; all outbound links return 200; no real token anywhere in the diff.
  • Two image blocks are intentionally commented out (live demo row + customer strip): they need a public demo publishable key swapped in for LOGO_DEV_PUBLISHABLE_KEY. One-line uncomment once the key decision lands — avoids shipping broken images.
  • Pre-merge glance: check the rendered README on this branch — the hero SVG uses a Geist-first font stack that falls back to system fonts in GitHub's renderer (layout has headroom; worst case is slightly different letterforms).
  • The badge snippet's raw.githubusercontent.com/.../main/... URL resolves once this merges to main (intended for third-party copy-paste; the repo page shows the badge via relative path).

🤖 Generated with Claude Code

@cursor

cursor Bot commented Jul 6, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@cursor

cursor Bot commented Jul 6, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@cursor

cursor Bot commented Jul 6, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@alexbaldwin
alexbaldwin merged commit d643676 into main Jul 6, 2026
1 check passed
@alexbaldwin
alexbaldwin deleted the alexbaldwin/readme-developer-hub branch September 1, 2026 20:33
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