Skip to content

docs(readme): lift sponsor placement - #1302

Merged
ryoppippi merged 2 commits into
mainfrom
codex/readme-sponsor-placement
Jun 12, 2026
Merged

ryoppippi merged 2 commits into
mainfrom
codex/readme-sponsor-placement

Conversation

@ryoppippi

@ryoppippi ryoppippi commented Jun 12, 2026 •

Copy link
Copy Markdown
Member

Moves the two major sponsor logos directly below the README screenshot, using a GitHub-compatible table layout instead of flex styling. Adds a short npx quick start before the detailed reference sections while keeping package runner details later in the README. Validated with git diff --check and the local Browser preview at http://localhost:3333/.


View with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is enabled.


Summary by cubic

Move the two major sponsor logos directly below the README screenshot and center them with inline HTML for reliable GitHub rendering. Add a one-line Quick Start (npx ccusage@latest), keep other runners under Installation (now “Package Runners”), and focus the bottom section on GitHub Sponsors.

Written for commit a1b0783. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Added a "Major Sponsors" block with sponsor logos and clarified sponsor recognition (renamed to "GitHub Sponsors" and removed duplicate logos)
    • Simplified Quick Start snippet for faster onboarding
    • Reorganized installation guidance into a "Package Runners" section and adjusted example commands (including an npx example)

Move the two major sponsor logos immediately below the product screenshot so they are visible before the detailed command reference.

Use a table instead of flex styling because GitHub README rendering does not reliably preserve inline flex CSS. Add a short npx quick start before the detailed usage sections and keep the broader package runner list later in the document.
@coderabbitai

coderabbitai Bot commented Jun 12, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Reorganizes the ccusage README: adds a "Major Sponsors" block and quick start snippet, replaces "Quick Start (Recommended)" with a "Package Runners" subsection (reordering runner examples), and renames the sponsors heading to "GitHub Sponsors" while removing a duplicate logo block.

Changes

README Sponsor Visibility and Quick Start Reorganization

Layer / File(s) Summary
Sponsor visibility and quick start promotion
apps/ccusage/README.md
Added a "Major Sponsors" block with sponsor logos and a simplified quick start snippet (npx ccusage@latest) near the top; replaced the "Quick Start (Recommended)" subsection with a "Package Runners" subsection and reordered/updated runner examples (npm, Nix, alternative runners); renamed the sponsors heading to "GitHub Sponsors" and removed the earlier "Sponsored by" logo block.

🎯 1 (Trivial) | ⏱️ ~3 minutes

A rabbit hopped and reordered the guide,
Logos gleamed bright, quick start by its side,
Runners aligned, the headings revised,
A tiny README dance—clean, concise! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(readme): lift sponsor placement' is clear and directly related to the main change—moving sponsor logos to a more prominent position in the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/readme-sponsor-placement

Comment @coderabbitai help to get the list of available commands and usage tips.

@ryoppippi

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 12, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 12, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
ccusage-guide a1b0783 Commit Preview URL

Branch Preview URL
Jun 12 2026, 11:37 AM

Replace the sponsor table with centered inline README markup so the two major sponsor logos sit in the middle of the rendered section.

Verified the updated layout in the local Browser preview at http://localhost:3333/ and reran git diff --check.
@ryoppippi

Copy link
Copy Markdown
Member Author

@coderabbitai review\n\nPushed a follow-up commit to center the sponsor logos in the rendered README preview.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Reviewed changes — a README restructuring that moves sponsor logos from the bottom to a new "Major Sponsors" section near the top, adds a minimal npx ccusage@latest Quick Start section, and renames/reorganizes the old Installation subsection.

  • Lift Major Sponsors to top of README — replaces bottom-of-page stacked <p> blocks with a side-by-side <table> layout directly below the tagline
  • Add Quick Start section — a one-line npx ccusage@latest code block between sponsors and the main content
  • Rename Quick Start (Recommended) to Package Runners — the old subsection under Installation is retitled and the package-runner list is reordered (npx ccusage@latest promoted to Quick Start; bunx ccusage moved to alternative runners)
  • Rename Sponsors to GitHub Sponsors — the bottom section now contains only the individual GitHub sponsors image

Pullfrog  | View workflow run | Using Big Pickle (free via Pullfrog for OSS) | 𝕏

@coderabbitai

coderabbitai Bot commented Jun 12, 2026 •

Copy link
Copy Markdown

@ryoppippi Sure! I'll review the latest changes, including the follow-up commit that centers the sponsor logos in the rendered README preview.

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ No new issues found.

Incremental review — commit a1b0783 replaces the <table> layout for sponsor logos with a <p align="center"> containing both logos separated by &nbsp;, centering them horizontally on the page. This is a reasonable refinement; the <table> approach would render with cells while the <p> centers naturally.

Pullfrog  | View workflow run | Using Big Pickle (free via Pullfrog for OSS) | 𝕏

@ryoppippi
ryoppippi merged commit d5418fc into main Jun 12, 2026
17 checks passed
@ryoppippi
ryoppippi deleted the codex/readme-sponsor-placement branch June 12, 2026 18:20
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