docs: add donation badge with QR code to README#40
Conversation
Add a "Support the Project" section with the USDT TRC-20 donation QR code, matching the other structured-world projects. Closes #39
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughA new "Support the Project" section is appended to ChangesREADME Donation Section
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
| @@ -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> | |||
There was a problem hiding this comment.
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.
- Shows the rendered state that T-Rex checked.
- Shows the rendered state that T-Rex checked.
- Shows the rendered state that T-Rex checked.
- Shows the rendered state that T-Rex checked.
| <div align="center"> | ||
|
|
||
|  |
There was a problem hiding this comment.
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.
|
|
||
| <div align="center"> | ||
|
|
||
|  |
There was a problem hiding this comment.
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.
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