diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index 01856f26..41932f04 100644 --- a/source/plugins/introduction/README.md +++ b/source/plugins/introduction/README.md @@ -1,21 +1,30 @@ -### 🙋 Introduction - -The *introduction* plugin display your account bio or your organization/repository description. -It is mostly intended for metrics used outside of GitHub, since these informations are already available on GitHub. - + - + + + + + + + + + + + + + + +
-
For an user or an organization - -
-
For a repository - -
- -

🙋 Introduction

This plugin displays account bio or organization/repository description.

+

It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub.

+
Supported features
→ Full specification
📗 Classic template 📘 Repository template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
For an user or an organization
+
For a repository
+ +
+ -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -45,9 +54,7 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml diff --git a/source/plugins/introduction/metadata.yml b/source/plugins/introduction/metadata.yml index 408f5331..b211c2af 100644 --- a/source/plugins/introduction/metadata.yml +++ b/source/plugins/introduction/metadata.yml @@ -1,5 +1,12 @@ name: "🙋 Introduction" category: github +description: | + This plugin displays account bio or organization/repository description. + + It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub. +examples: + +for an user or an organization: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.svg + for a repository: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.repository.svg index: 22 supports: - user