Skip to content
GitHub Sponsor avatar listings in your Readme.md
Go
Branch: master
Clone or download

Latest commit

tj Merge pull request #2 from clovisphere/master
docs: remove extra 'which' in the README 'Deploying' section
Latest commit 7b8247b May 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Initial commit May 28, 2020
cmd/sponsors-api Initial commit May 28, 2020
.gitignore Initial commit May 28, 2020
LICENSE Initial commit May 28, 2020
Readme.md Merge pull request #2 from clovisphere/master May 28, 2020
go.mod Initial commit May 28, 2020
go.sum Initial commit May 28, 2020
server.go Initial commit May 28, 2020

Readme.md

Sponsors API

Sponsors API is a GitHub Sponsors server for displaying sponsor avatars in your project Readme. It looks like this:

Deploying

Deploy to host 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.

You can’t perform that action at this time.