From 043c05cab414065c624c50930511b90914d1e6b3 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 19:43:43 -0500 Subject: [PATCH] doc(plugins/stargazers): update --- source/plugins/stargazers/README.md | 38 ++++++++++++++++---------- source/plugins/stargazers/metadata.yml | 6 ++-- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index bbbfc233..0ae20a29 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -1,15 +1,27 @@ -### ✨ Stargazers over last weeks - -The *stargazers* plugin displays your stargazers evolution across all of your repositories over the last two weeks. - + - + + + + + + + + + + + + + + +
- - -

✨ Stargazers over last weeks

This plugin displays your stargazers evolution across all of your repositories over the last two weeks.

+
Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+ +
+ -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -18,7 +30,7 @@ The *stargazers* plugin displays your stargazers evolution across all of your re - @@ -29,9 +41,7 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
plugin_stargazers

Display stargazers metrics

+

Enable stargazers plugin

-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -44,4 +54,4 @@ with: plugin_stargazers: 'yes' ``` - \ No newline at end of file + diff --git a/source/plugins/stargazers/metadata.yml b/source/plugins/stargazers/metadata.yml index 1bf6283d..e9889093 100644 --- a/source/plugins/stargazers/metadata.yml +++ b/source/plugins/stargazers/metadata.yml @@ -1,5 +1,8 @@ name: "✨ Stargazers over last weeks" category: github +description: This plugin displays your stargazers evolution across all of your repositories over the last two weeks. +example: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg index: 10 supports: - user @@ -9,8 +12,7 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_stargazers: - description: Display stargazers metrics + description: Enable stargazers plugin type: boolean default: no