Skip to content

docs: add Community Projects section (cc-usage-board, ai-heatmap)#987

Open
huhjayeon wants to merge 2 commits into
ryoppippi:mainfrom
huhjayeon:add-community-projects-section
Open

docs: add Community Projects section (cc-usage-board, ai-heatmap)#987
huhjayeon wants to merge 2 commits into
ryoppippi:mainfrom
huhjayeon:add-community-projects-section

Conversation

@huhjayeon
Copy link
Copy Markdown

@huhjayeon huhjayeon commented May 12, 2026

Adds a Community Projects section to the README with two third-party tools that build on ccusage:

Happy to revise wording, drop either entry, or move the section elsewhere.

Summary by CodeRabbit

  • Documentation
    • Added a "Community Projects" section highlighting two community tools:
      • cc-usage-board — local bilingual dashboard with multiple charts, activity heatmap, and SwiftBar plugin.
      • ai-heatmap — GitHub-style cost heatmap usable as static pages or dynamic SVG for hosted deployments.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 33281277-1811-439c-922d-69f409face42

📥 Commits

Reviewing files that changed from the base of the PR and between bdb674d and ef6d34e.

📒 Files selected for processing (1)
  • apps/ccusage/README.md

📝 Walkthrough

Walkthrough

Adds a new "Community Projects" section to apps/ccusage/README.md documenting two third-party projects: cc-usage-board (local bilingual dashboard with charts and SwiftBar plugin) and ai-heatmap (GitHub-style cost heatmap via static pages or dynamic SVG).

Changes

Community Projects Documentation

Layer / File(s) Summary
Community Projects section
apps/ccusage/README.md
Adds a "Community Projects" section describing cc-usage-board (local HTML dashboard, English/Korean UI, locale-aware units, multiple charts, activity heatmap, optional SwiftBar plugin) and ai-heatmap (GitHub-style cost heatmap served via GitHub Pages or dynamic SVG on Vercel).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • ryoppippi

Poem

🐰 In README light the projects bloom,
Two tools now listed make the page less gloom,
Dashboards in two tongues, heatmaps that gleam,
Little community sparks fuel the dream. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a Community Projects section with two specific community tools (cc-usage-board and ai-heatmap).
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@huhjayeon
Copy link
Copy Markdown
Author

Update — cc-usage-board now ships with full Japanese support (UI + menu bar plugin + README):

  • Trilingual cycle: 한국어 → 日本語 → English in one click
  • Japanese number units (万 / 億) alongside Korean (만 / 억) and English (K / M / B)
  • README.ja.md added
  • SwiftBar plugin language is auto-detected from $LANG (ja_* → JA) and switchable from the menu

Since ccusage was originally built by you in Japan, I figured Japanese-speaking
Claude Code users would benefit. Happy to revise this PR if anything in the
proposed README addition should change.

@huhjayeon huhjayeon changed the title docs: add Community Projects section with cc-usage-board docs: add Community Projects section (cc-usage-board, ai-heatmap) May 12, 2026
@huhjayeon
Copy link
Copy Markdown
Author

Extended the PR to also include ai-heatmap, which was requested in #852, and tightened the cc-usage-board entry to match the surrounding "ccusage Family" style. Title/body updated accordingly.

cc @seunggabi — including ai-heatmap as you requested in #852.

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