/sponsors-api

GitHub Sponsor avatar listings in your Readme.md

Primary LanguageGoMIT LicenseMIT

Sponsors API

Sponsors API is a GitHub Sponsors server for displaying sponsor avatars in your project Readme. It looks like this, you can list as many as you want.

Deploying

Deploy to host which which supports HTTP, for example using Apex Up or Heroku. The following environment variables are supported:

  • GITHUB_TOKEN the GitHub API token (no scopes are required)
  • PORT the server port (defaults to 3000)
  • URL the url to your endpoint such as "https://sponsors.myhost.com" (optional)

Usage

Visit the /sponsor/markdown path for the markdown to copy/paste. Sponsors are cached for an hour by default, tweak with the -cache-ttl flag.