UNPKG

@jamesives/github-sponsors-readme-action

Version:

This GitHub Action will automatically add your GitHub Sponsors to your README. It can be configured in multiple ways allowing you to display and breakdown your sponsors by price tier with fallbacks.

14 lines (13 loc) 548 B
import { ActionInterface, GitHubResponse, Status } from './constants'; /** * Fetches sponsors from the GitHub Sponsors API. */ export declare function getSponsors(action: ActionInterface): Promise<GitHubResponse>; /** * Generates the sponsorship template. */ export declare function generateTemplate(response: GitHubResponse, action: ActionInterface): string; /** * Generates the updated file with the attached sponsorship template. */ export declare function generateFile(response: GitHubResponse, action: ActionInterface): Promise<Status>;