sponsorkit
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.2 • Public • Published

    SponsorKit

    NPM version

    Toolkit for generating sponsors images.

    Usage

    Create .env file with:

    ; GitHub provider.
    ; Token requires the `read:user` and `read:org` scopes.
    SPONSORKIT_GITHUB_TOKEN=your_github_token
    SPONSORKIT_GITHUB_LOGIN=your_github_username
    
    ; Patreon provider.
    ; Create v2 API key at https://www.patreon.com/portal/registration/register-clients
    ; and use the "Creator’s Access Token".
    SPONSORKIT_PATREON_TOKEN=your_patreon_token

    Only one provider is required to be configured.

    Run:

    npx sponsorkit
    

    Example Setup | GitHub Actions Setup | Generated SVG

    Configurations

    Create sponsorkit.config.js file with:

    import { defineConfig, presets } from 'sponsorkit'
    
    export default defineConfig({
      // Providers configs
      github: {
        login: 'antfu',
        type: 'user',
      },
    
      // Rendering configs
      width: 800,
      formats: ['json', 'svg', 'png'],
      tiers: [
        {
          title: 'Backers',
          preset: presets.base,
        },
        {
          title: 'Sponsors',
          monthlyDollars: 10,
          preset: presets.medium,
        },
        {
          title: 'Silver Sponsors',
          monthlyDollars: 50,
          preset: presets.large,
        },
        {
          title: 'Gold Sponsors',
          monthlyDollars: 100,
          preset: presets.xl,
        },
      ],
    })

    Also check the example.

    Utils

    You can also use SponsorKit programmatically:

    import { fetchSponsors } from 'sponsorkit'
    
    const sponsors = await fetchSponsors(token, login)

    Check the type definition or source code for more utils available.

    Sponsors

    License

    MIT License © 2022 Anthony Fu

    Install

    npm i sponsorkit

    DownloadsWeekly Downloads

    130

    Version

    0.4.2

    License

    MIT

    Unpacked Size

    49.5 kB

    Total Files

    12

    Last publish

    Collaborators

    • antfu