Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
polaz merged 2 commits into from
Jun 20, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
529fc83
docs: add donation badge with QR code to README
polaz Jun 20, 2026
e3d90cb
Merge branch 'main' into docs/#39-donation-badge
polaz Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,16 @@ Client (HTTP/JSON)
Upstream Service
```

## Support the Project

<div align="center">

![USDT TRC-20 Donation QR Code](./assets/usdt-qr.svg)
Comment on lines +215 to +217

@greptile-apps greptile-apps Bot Jun 20, 2026

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

@greptile-apps greptile-apps Bot Jun 20, 2026

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


USDT (TRC-20): `TFDsezHa1cBkoeZT5q2T49Wp66K8t2DmdA`

</div>

## License

Apache-2.0
1 change: 1 addition & 0 deletions assets/usdt-qr.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.