Skip to content

add release downloads badge and CLAUDE.md#56

Merged
harumiWeb merged 1 commit into
mainfrom
docs/update-docs
Apr 16, 2026
Merged

add release downloads badge and CLAUDE.md#56
harumiWeb merged 1 commit into
mainfrom
docs/update-docs

Conversation

@harumiWeb
Copy link
Copy Markdown
Owner

@harumiWeb harumiWeb commented Apr 16, 2026


Open with Devin

Summary by CodeRabbit

  • Documentation
    • Added a new documentation file.
    • Updated README files with an additional GitHub Downloads badge to the existing badge row.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

A new reference file CLAUDE.md is created, and GitHub Downloads badges are appended to the centered badge rows in both README.md and README.en.md.

Changes

Cohort / File(s) Summary
New Documentation Reference
CLAUDE.md
New file added with single-line reference to AGENTS.md.
Badge Updates
README.md, README.en.md
GitHub Downloads badge appended to centered badge row in both README files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A new file hops into place,
Badges shine with download grace,
Documentation takes its stand,
References linked, perfectly planned! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the two main changes in the pull request: adding a GitHub Downloads badge to the README files and creating the new CLAUDE.md file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-docs

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.

Copy link
Copy Markdown

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
CLAUDE.md (1)

1-1: Use a clickable Markdown link for the agent reference.

Current text is readable, but making it a proper link improves doc usability.

✏️ Proposed doc tweak
-@AGENTS.md
+[AGENTS.md](AGENTS.md)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 1, Replace the plain reference "@AGENTS.md" with a
clickable Markdown link by changing it to a bracketed link like
[AGENTS](AGENTS.md) so the document points users directly to the AGENTS.md page;
locate the literal token "@AGENTS.md" in the CLAUDE.md content and update it to
the Markdown link format.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CLAUDE.md`:
- Line 1: Replace the plain reference "@AGENTS.md" with a clickable Markdown
link by changing it to a bracketed link like [AGENTS](AGENTS.md) so the document
points users directly to the AGENTS.md page; locate the literal token
"@AGENTS.md" in the CLAUDE.md content and update it to the Markdown link format.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5be9e072-4ded-4dec-97b5-622e1dffd040

📥 Commits

Reviewing files that changed from the base of the PR and between 0dbd125 and 4209057.

📒 Files selected for processing (3)
  • CLAUDE.md
  • README.en.md
  • README.md

@harumiWeb harumiWeb merged commit c9465c1 into main Apr 16, 2026
9 checks passed
@harumiWeb harumiWeb deleted the docs/update-docs branch April 16, 2026 10:02
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