This allows you list your GitHub or other platform sponsors in a .MD file based on a BACKERS.md file.

This defaults to the README.md at the root of your repository (which is the file that renders your profile) but you can specify any file in your repo, as long as it contains the following comments:

<!-- SPONSORS-LIST:START -->
<!-- SPONSORS-LIST:END -->

In your repository workflow file, you provide the path to your SPONSORS.yaml file that you want to make up your Sponsors section. Here's an example workflow that will run when SPONSORS.yaml receives a change.

name: Update Sponsors
on:
  push:
    path: "./.github/SPONSORS.yml"

jobs:
  update-sponsors-section:
    name: Update this repo's README's sponsors.
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: matthewjdegarmo/Sponsors@latest
        with:
          sponsors_file: ./.github/SPONSORS.yaml
          readme_file: ./README.md

The above workflow will render the following table in your root README.md file in your repository.

---

Thanks to all of my Supporters

GitHub Supporters

Twitch Supporters

---

Content of this SPONSORS.yaml file.

MainHeading: Thanks to all of my Supporters

Platforms:
  - GitHub:
    - matthewjdegarmo
    - brrees01
    - ctmcisco
    - EdwardHanlon
    - thefirstnoe1

  - Twitch:
    - matthewjdegarmo
    - brettmillerit
    - ghostyjungle