From ac2dffc4d6848fbdcac0ecdb5c1881dbaa28cdae Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20D=C3=A9ramond?= <juderamond@gmail.com>
Date: Sun, 22 Sep 2024 18:22:38 +0200
Subject: [PATCH] feat: update README.md

---
 README.md | 44 ++++++++++++++++++++------------------------
 1 file changed, 20 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 49069ee..34c0f45 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,31 @@
-# SponsorKit Starter Template
+# Sponsors
 
-## About
+This repository is a host for static files used to display sponsors in other repositories.
 
-`sponsorkit-starter` is a GitHub template repository for [SponsorKit](https://github.com/antfu/sponsorkit/) toolkit for automatically generating sponsors images from GitHub Sponsors.
+It has been created from [SponsorKit Starter Template](https://github.com/open-reSource/sponsorkit-starter).
 
-It is heavily inspired by [antfu/static](https://github.com/antfu/static).
+## Generated files
 
-## Repo Template
+### `sponsors.part1.svg`
 
-Setup as a starter template, you can easily generate a new GitHub repository. From the repository homepage, click the "Use this template" button.
+<p align="center">
+  <img src='https://cdn.jsdelivr.net/gh/Open-reSource/sponsors/sponsors.part1.svg'/>
+</p>
 
-## What's Included
-* `.github/workflows/scheduler.yml` that runs the SponsorKit action on a schedule every day, for each merge on the _main_ branch, or manually.
-* `.env.example` as described in [SponsorKit usage](https://github.com/antfu/sponsorkit/#usage).
-* `build.sh` script to generate the sponsors images.
-* `package.json` relying on the latest version of SponsorKit and containing the `build` script.
-* `sponsor.config.ts` that contains the configuration for the generation of the sponsors images.
+### `sponsors.part2.svg`
 
-## Usage
+<p align="center">
+  <img src='https://cdn.jsdelivr.net/gh/Open-reSource/sponsors/sponsors.part2.svg'/>
+</p>
 
-1. Create a new repository from this template.
-1. Change its default settings to have “Read an write permissions” for the “Workflow permissions” option in "Actions" section.
-1. Modify `.github/workflows/scheduler.yml` to set your GitHub username for the `SPONSORKIT_GITHUB_LOGIN` environment variable.
-1. Create a `SPONSORS_TOKEN` secret in your repository settings with a [GitHub personal access token (classic)](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) with the `read:org` and `read:user` scopes.
-1. (Optional) Modify the `sponsor.config.ts` file to match your needs.
-1. Commit and push your changes to the _main_ branch. It will trigger the workflow, generate and commit the sponsors images at the root level of your repository.
+### `sponsors.svg`
 
-### Manual Generation
+<p align="center">
+  <img src='https://cdn.jsdelivr.net/gh/Open-reSource/sponsors/sponsors.svg'/>
+</p>
 
-You can also generate the sponsors images locally by running the `build.sh` script.
+### `sponsors.wide.svg`
 
-For that, you need to copy `.env.example` to `.env` and set the `SPONSORKIT_GITHUB_TOKEN` and `SPONSORKIT_GITHUB_LOGIN` variables.
-
-And then simply run `npm run build`.
+<p align="center">
+  <img src='https://cdn.jsdelivr.net/gh/Open-reSource/sponsors/sponsors.wide.svg'/>
+</p>