Back to docs
Recipe

Recipe: FUNDING.yml + sponsor-tier writer

Automate sponsor recognition by wiring your GitHub sponsor tiers directly into a FUNDING.yml manifest. This recipe pairs a tier-aware writer with a verified sponsor badge pipeline.

Ingredients

  • A public GitHub repository with sponsor tiers enabled
  • Meridian CLI v2.3+ installed and authenticated
  • A sponsor-writer plugin key from your dashboard

Step 1 — Scaffold the manifest

Run the init command to generate a tier-aware FUNDING.yml in your repo root. The writer inspects your GitHub sponsor tiers and maps them to platform-specific fields.

meridian funding init --tiers sponsor-writer

Step 2 — Configure tier mapping

Open the generated funding.yml and verify the tier-to-platform mapping. Each tier can target GitHub Sponsors, Patreon, Open Collective, or Ko-fi.

tiers:
  - name: "Backer"
    min: 5
    platforms: [github, patreon]
  - name: "Supporter"
    min: 15
    platforms: [github, open_collective]
  - name: "Sponsor"
    min: 50
    platforms: [github, kofi]

Step 3 — Validate & push

The writer validates tier thresholds, platform slugs, and YAML syntax before you commit. Run the check command to confirm everything resolves.

meridian funding validate

Once validation passes, commit and push. GitHub will automatically surface your sponsor button and tier options on the repository sidebar.

Verification

Visit your repo's Insights → Sponsors tab to confirm tiers are live. The Meridian dashboard will show a green “FUNDING.yml active” badge within 60 seconds of the push.

Need help? Troubleshooting guide or reach out on Discord.