Rewrite README as a developer hub, add MIT LICENSE and brand assets - #3
Merged
Conversation
|
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. |
|
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. |
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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-apitopic — done separately in repo settings).Reviewer notes
LOGO_DEV_PUBLISHABLE_KEY. One-line uncomment once the key decision lands — avoids shipping broken images.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