diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index 6c545b52..219b9ede 100644 --- a/source/plugins/sponsors/README.md +++ b/source/plugins/sponsors/README.md @@ -1,20 +1,29 @@ -### 💕 GitHub Sponsors - -The *sponsors* plugin lets you display your sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/). - + - + + + + + + + + + + + + + + +
-
GitHub sponsors card - -
-
GitHub sponsors full introduction - -
- -

💕 GitHub Sponsors

This plugin displays sponsors and introduction text from GitHub sponsors.

+
Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
GitHub sponsors card
+
GitHub sponsors full introduction
+ +
+ -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -46,9 +55,7 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -72,4 +79,4 @@ with: plugin_sponsors: 'yes' ``` - \ No newline at end of file + diff --git a/source/plugins/sponsors/metadata.yml b/source/plugins/sponsors/metadata.yml index ed1f8c50..0b42c106 100644 --- a/source/plugins/sponsors/metadata.yml +++ b/source/plugins/sponsors/metadata.yml @@ -1,5 +1,9 @@ name: "💕 GitHub Sponsors" category: github +description: This plugin displays sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/). +examples: + +GitHub sponsors card: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg + +GitHub sponsors full introduction: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg index: 23 supports: - user