Skip to content

docs: add donation badge with QR code to README#40

Merged
polaz merged 2 commits into
mainfrom
docs/#39-donation-badge
Jun 20, 2026
Merged

docs: add donation badge with QR code to README#40
polaz merged 2 commits into
mainfrom
docs/#39-donation-badge

Conversation

@polaz

@polaz polaz commented Jun 20, 2026

Copy link
Copy Markdown
Member

Adds a Support the Project section with the USDT TRC-20 donation QR code at the bottom of the README, matching the other structured-world projects (e.g. gitlab-mcp). Same wallet and QR asset.

Closes #39

Add a "Support the Project" section with the USDT TRC-20 donation QR
code, matching the other structured-world projects.

Closes #39
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f8468989-8f8d-4dc4-81de-7fb7f3748ef6

📥 Commits

Reviewing files that changed from the base of the PR and between 8489371 and 529fc83.

⛔ Files ignored due to path filters (1)
  • assets/usdt-qr.svg is excluded by !**/*.svg
📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added "Support the Project" section to README with donation information for USDT (TRC-20) contributions.

Walkthrough

A new "Support the Project" section is appended to README.md. It contains a centered donation QR code image (./assets/usdt-qr.svg) and a USDT (TRC-20) wallet address for accepting donations.

Changes

README Donation Section

Layer / File(s) Summary
Support the Project section
README.md
Adds a centered SVG QR code and a USDT (TRC-20) donation address as a new section at the bottom of the README.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a donation badge with QR code to the README.
Description check ✅ Passed The description is related to the changeset, providing context about the Support the Project section and alignment with other projects.
Linked Issues check ✅ Passed The PR successfully implements the requirement from issue #39 to add a Support the Project section with USDT TRC-20 donation QR code to the README.
Out of Scope Changes check ✅ Passed All changes in the PR are directly related to adding the Support the Project section as specified in issue #39, with no out-of-scope modifications.
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/#39-donation-badge

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

@greptile-apps

greptile-apps Bot commented Jun 20, 2026

Copy link
Copy Markdown

Greptile Summary

  • Adds a new Support the Project section to README.md.
  • Shows a USDT TRC-20 donation address in plaintext.
  • Adds and references a new QR SVG asset under assets/usdt-qr.svg.

Confidence Score: 4/5

The change is documentation-only, but the README image path needs attention for package and documentation renderers outside the repository view.

The modified surface is small and easy to reason about, and the main compatibility concern is isolated to the new donation QR image reference.

README.md

T-Rex T-Rex Logs

What T-Rex did

  • Ran a local package README asset resolution harness to reproduce the README render without repository asset directories, and observed the donation QR image resolving to /assets/usdt-qr.svg with HTTP 404; the harness exited with its intentional reproduction failure code after logging image_load_result=broken.
  • Compared the before-and-after artifact states to verify the donation content was added, and confirmed with a Git tree lookup that assets/usdt-qr.svg exists and is an SVG file referenced by a centered QR reference in the updated README.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (2): Last reviewed commit: "Merge branch 'main' into docs/#39-donati..." | Re-trigger Greptile

Comment thread assets/usdt-qr.svg
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="200" height="200" viewBox="0 0 33 33" shape-rendering="crispEdges"><path fill="#FFFFFF" d="M0 0h33v33H0z"/><path stroke="#000000" d="M2 2.5h7m1 0h2m1 0h1m3 0h3m1 0h1m2 0h7M2 3.5h1m5 0h1m1 0h3m5 0h2m1 0h1m2 0h1m5 0h1M2 4.5h1m1 0h3m1 0h1m1 0h2m1 0h2m2 0h2m2 0h1m2 0h1m1 0h3m1 0h1M2 5.5h1m1 0h3m1 0h1m3 0h1m1 0h1m3 0h2m1 0h1m2 0h1m1 0h3m1 0h1M2 6.5h1m1 0h3m1 0h1m1 0h1m2 0h2m1 0h4m1 0h2m1 0h1m1 0h3m1 0h1M2 7.5h1m5 0h1m3 0h2m3 0h4m3 0h1m5 0h1M2 8.5h7m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h1m1 0h7M13 9.5h1m1 0h1m1 0h2m1 0h2M2 10.5h1m2 0h6m2 0h3m2 0h6m2 0h1m1 0h3M2 11.5h4m1 0h1m1 0h1m2 0h1m1 0h2m2 0h1m2 0h2m2 0h2m1 0h2M2 12.5h1m1 0h1m3 0h3m2 0h3m1 0h2m3 0h1m1 0h1m2 0h1M3 13.5h1m1 0h1m4 0h1m2 0h1m1 0h1m2 0h3m1 0h2m1 0h1m1 0h1m2 0h1M4 14.5h1m1 0h4m1 0h2m2 0h1m1 0h2m1 0h2m2 0h2m1 0h1m2 0h1M2 15.5h1m2 0h3m1 0h2m1 0h1m2 0h2m1 0h1m2 0h1m2 0h3m1 0h1M3 16.5h1m4 0h2m2 0h1m2 0h1m1 0h3m1 0h1m2 0h1m5 0h1M3 17.5h2m1 0h1m2 0h1m1 0h4m5 0h5m1 0h3M3 18.5h1m3 0h3m3 0h1m2 0h2m1 0h1m5 0h3M2 19.5h5m8 0h3m2 0h2m1 0h2m1 0h1m1 0h1m1 0h1M2 20.5h5m1 0h2m1 0h1m1 0h1m3 0h1m2 0h2m1 0h1m3 0h1m2 0h1M2 21.5h3m2 0h1m2 0h4m2 0h1m1 0h1m2 0h2m1 0h1m1 0h1m1 0h1M2 22.5h3m1 0h4m2 0h2m1 0h2m1 0h10m2 0h1M10 23.5h2m1 0h2m1 0h2m1 0h1m1 0h2m3 0h1m2 0h2M2 24.5h7m1 0h4m2 0h2m1 0h4m1 0h1m1 0h1m1 0h1M2 25.5h1m5 0h1m1 0h2m4 0h1m2 0h4m3 0h2M2 26.5h1m1 0h3m1 0h1m1 0h3m1 0h5m2 0h7m1 0h2M2 27.5h1m1 0h3m1 0h1m1 0h1m1 0h1m2 0h1m2 0h1m3 0h2m3 0h2m1 0h1M2 28.5h1m1 0h3m1 0h1m2 0h1m2 0h1m1 0h3m5 0h3m2 0h2M2 29.5h1m5 0h1m2 0h1m2 0h1m1 0h3m1 0h2m1 0h4m1 0h1m1 0h1M2 30.5h7m1 0h1m2 0h2m2 0h2m1 0h1m1 0h2m1 0h3"/></svg>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 QR code fails scanning

The new SVG renders as a QR-like image, but common QR decoders could not detect or decode it after rasterizing the asset at both normal and larger sizes. A user who scans the README image can get no wallet payload, so the donation QR code does not work even though the plaintext address is visible. Regenerate this SVG with a valid QR quiet zone and verify it decodes to TFDsezHa1cBkoeZT5q2T49Wp66K8t2DmdA before merging.

Artifacts

Repro: QR rasterization and decode script

  • Contains supporting evidence from the run (text/javascript; charset=utf-8).

Repro: verbose QR decode output for normal and large rasterizations

  • Keeps the command output available without making the summary code-heavy.

Imagemagick Usdt Qr 200

  • Shows the rendered state that T-Rex checked.

Imagemagick Usdt Qr 660

  • Shows the rendered state that T-Rex checked.

Usdt Qr 200

  • Shows the rendered state that T-Rex checked.

Usdt Qr 660

  • Shows the rendered state that T-Rex checked.

View artifacts

T-Rex Ran code and verified through T-Rex

Comment thread README.md
Comment on lines +215 to +217
<div align="center">

![USDT TRC-20 Donation QR Code](./assets/usdt-qr.svg)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 QR image won't render

This wraps Markdown image syntax inside a raw HTML div. In GitHub/CommonMark-style rendering, Markdown inside that HTML block is not parsed as an image, so the support section can show the literal image syntax or degrade to a link instead of displaying the QR code. That breaks the visible donation QR code this section is adding.

Artifacts

Repro: README markdown-it rendering harness

  • Contains supporting evidence from the run (text/javascript; charset=utf-8).

Repro: rendered Support section HTML and QR img checks

  • Keeps the command output available without making the summary code-heavy.

Repro: generated HTML from the actual README

  • Contains supporting evidence from the run (text/html; charset=utf-8).

Repro: Playwright screenshot harness attempted for browser capture

  • Contains supporting evidence from the run (text/javascript; charset=utf-8).

Repro: Playwright launch failure showing missing Chromium system dependency

  • Keeps the command output available without making the summary code-heavy.

View artifacts

T-Rex Ran code and verified through T-Rex

@polaz polaz merged commit 2185f21 into main Jun 20, 2026
1 check passed
Comment thread README.md

<div align="center">

![USDT TRC-20 Donation QR Code](./assets/usdt-qr.svg)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Use stable image URL

This README is also the crate README, but the new QR image uses the repo-relative path ./assets/usdt-qr.svg. Package and documentation renderers do not consistently serve README assets from that relative location, so users viewing the package README outside GitHub can see a broken image instead of the donation QR code. Use an absolute raw/GitHub asset URL for this image so the support section renders in all README contexts.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Artifacts

Repro: package README asset resolution harness

  • Contains supporting evidence from the run (text/x-python; charset=utf-8).

Repro: harness output showing broken QR asset request

  • Keeps the command output available without making the summary code-heavy.

View artifacts

T-Rex Ran code and verified through T-Rex

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.

docs: add donation badge with QR code to README

1 participant