Skip to main content

​
README Badge

Add a small, professional badge to your project’s README, website, or bio that links straight to your PayRequest Page. It’s a one-click copy from your dashboard — no design work, no image hosting, nothing to maintain.
The badge is available for every PayRequest Page that has a handle set (your payrequest.me/your-handle link). If you haven’t chosen a handle yet, do that first from PayRequest Page → Overview.

​
Overview

One-Click Copy

Grab a ready-made snippet from your dashboard — nothing to write or format yourself.

Works Anywhere Markdown Does

GitHub, GitLab, npm packages, blogs, forums — anywhere that renders Markdown or plain images and links.

Always Current

The badge reflects your page live — if you’re running a donation goal, it shows the amount raised right now.

Matches Your Page Mode

The wording adapts automatically depending on whether your page is set to Products, Amounts, or Donation mode.

​
How to Get Your Badge

1

Open PayRequest Page

Go to PayRequest Page from the main menu — you’ll land on the Overview tab by default.
2

Find the README badge card

In the left-hand sidebar, look for the README badge card, just below the Page Mode card. This only appears once your page has a handle.
3

Copy the snippet

Click the copy icon in the field — it copies a ready-to-paste snippet that already includes your handle and links to your live PayRequest Page.
4

Paste it wherever you like

Drop it into your GitHub README, your website, or anywhere else — see below for specific examples.

​
Adding It to GitHub

1

Open your repository's README.md

On GitHub, click the pencil (edit) icon on your README.md file, or edit it locally and push the change.
2

Paste the snippet

Paste the copied snippet near the top of the file, or under a Support / Sponsor heading further down — both are common conventions.
3

Commit the change

Commit directly to your default branch, or open a pull request if that’s your project’s convention.
4

Check it renders

Open the repository page on GitHub — your badge should appear as a small clickable image. Clicking it takes visitors straight to your PayRequest Page.
A common pattern is to place it right after your project title and description, alongside other badges like build status or version — that’s usually the first thing visitors see.

​
Adding It Elsewhere

The snippet is standard Markdown, so it works anywhere Markdown is supported:
WhereHow
GitLab / BitbucketSame as GitHub — paste into README.md
npm / PyPI package READMEPaste into the README file that ships with your package
Blog postsMost blogging platforms (Ghost, Dev.to, Hashnode) accept the same Markdown snippet
Forum signaturesIf the forum only accepts an image + link (not Markdown), use the plain image address shown next to the snippet and wrap it in your forum’s own link format
A plain websiteUse the badge as a normal <img> tag pointing to the same image address, wrapped in a link to your PayRequest Page
If a platform doesn’t support Markdown, you can still use the badge — it’s just a small image. Right-click the rendered badge on your own page (or ask a developer friend) to grab the direct image address, then use it with that platform’s own image + link syntax.

​
What the Badge Shows

The text on the badge updates automatically based on your Page Mode:
Page ModeBadge shows
Products & services or Amount buttons”Pay with PayRequest”
Donation mode (no goal set)“Support me · PayRequest”
Donation mode (goal set)“Support me · €X raised” — the live total for your current goal period
You don’t need to update the badge yourself when your donation total changes — anyone viewing your README or website always sees the current amount, refreshed every few minutes.

​
Frequently Asked Questions

Yes. Your handle is what makes your PayRequest Page URL (payrequest.me/your-handle) and it’s also part of the badge image address. Set one from PayRequest Page → Overview if you haven’t already.
Not currently — the badge uses a consistent PayRequest style so it’s instantly recognizable, and the wording is chosen automatically based on your Page Mode.
No. It’s a tiny image, similar in size to any other status badge you might already be using.
Update the badge snippet with your new handle — old links using the previous handle will stop matching your page, so re-copy the snippet from your dashboard after a handle change.
Yes — the badge has its own fixed background color, so it stays legible in both GitHub’s light and dark themes.

​
Next Steps

Donation Mode

Turn your page into a fundraising goal with a live progress bar and donor feed — your badge shows the running total.

PayRequest Page Styling

Brand your page with an avatar, tagline, accent color, and social links.

Coffee Tips

A friendlier “Buy Me a Coffee”-style version of Donation Mode with a drinks menu and GIFs.

Custom Domains

Use your own domain for your PayRequest Page instead of payrequest.me.