From 6aa7e159db3636395044c8192eec29ba3f9703af Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 19:44:04 -0500 Subject: [PATCH] doc(plugins/support): update --- source/plugins/support/README.md | 40 +++++++++++++++++------------ source/plugins/support/metadata.yml | 7 +++-- 2 files changed, 29 insertions(+), 18 deletions(-) diff --git a/source/plugins/support/README.md b/source/plugins/support/README.md index 6e52bc45..3802024d 100644 --- a/source/plugins/support/README.md +++ b/source/plugins/support/README.md @@ -1,17 +1,27 @@ -### 💭 GitHub Community Support - -The *support* plugin lets you display your statistics from [GitHub Support Community](https://github.community/). - + - + + + + + + + + + + + + + + +
- - -

💭 GitHub Community Support

This plugin displays your statistics from GitHub Support Community (an account must be created on it beforehand).

+
Supported features
→ Full specification
📗 Classic template
👤 Users
No tokens are required for this plugin
+ +
+ -An account on [GitHub Support Community](https://github.community/) is required to use this plugin. - -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -20,7 +30,7 @@ An account on [GitHub Support Community](https://github.community/) is required - @@ -31,9 +41,7 @@ An account on [GitHub Support Community](https://github.community/) is required
plugin_support

GitHub Community Support metrics

+

Enable support plugin

-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -46,4 +54,4 @@ with: plugin_support: 'yes' ``` - \ No newline at end of file + diff --git a/source/plugins/support/metadata.yml b/source/plugins/support/metadata.yml index 3e790dcd..204a6910 100644 --- a/source/plugins/support/metadata.yml +++ b/source/plugins/support/metadata.yml @@ -1,13 +1,16 @@ name: "💭 GitHub Community Support" category: github +description: This plugin displays your statistics from [GitHub Support Community](https://github.community/) (an account must be created on it beforehand). + +example: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.support.svg index: 17 supports: - user scopes: [] inputs: - # Enable or disable plugin plugin_support: - description: GitHub Community Support metrics + description: Enable support plugin type: boolean default: no \ No newline at end of file