diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md
index 68f694ab..2ee6a6c0 100644
--- a/source/plugins/starlists/README.md
+++ b/source/plugins/starlists/README.md
@@ -1,15 +1,28 @@
-### đĢ Starlists
-
-The *starlists* plugin displays your recently star lists.
-
+
@@ -18,7 +31,7 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists |
- Display star lists
+ | Enable starlists plugin
![]() |
@@ -29,7 +42,7 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists_limit |
- Number of star lists to display
+ | Display limit (star lists)
![]() |
@@ -43,7 +56,7 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists_limit_repositories |
- Number of repositories to display per star lists
+ | Display limit (repositories per star list)
![]() |
@@ -57,7 +70,7 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists_shuffle_repositories |
- Shuffle displayed repositories
+ | Shuffle data for varied outputs
![]() |
@@ -68,7 +81,7 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists_ignored |
- Star lists to skip
+ | Skipped star lists (case insensitive)
![]() |
@@ -79,7 +92,8 @@ The *starlists* plugin displays your recently star lists.
plugin_starlists_only |
- Star lists to display
+ | Restrict display to specified star lists (case insensitive)
+This option is equivalent to plugin_starlists_ignored with all star lists but the ones listed in this option
![]() |
@@ -91,9 +105,7 @@ The *starlists* plugin displays your recently star lists.
-*[â Full specification](metadata.yml)*
-
-#### âšī¸ Examples workflows
+## âšī¸ Examples workflows
```yaml
@@ -108,4 +120,4 @@ with:
plugin_starlists_only: đ¤ TC39
```
-
\ No newline at end of file
+
diff --git a/source/plugins/starlists/metadata.yml b/source/plugins/starlists/metadata.yml
index 55f4aa96..8c872073 100644
--- a/source/plugins/starlists/metadata.yml
+++ b/source/plugins/starlists/metadata.yml
@@ -1,51 +1,50 @@
name: "đĢ Starlists"
category: github
+description: This plugin displays your star lists.
+examples:
+ default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg
index: 24
supports:
- user
scopes: []
inputs:
- # Enable or disable plugin
plugin_starlists:
- description: Display star lists
+ description: Enable starlists plugin
type: boolean
default: no
- # Number of star lists to display
plugin_starlists_limit:
- description: Number of star lists to display
+ description: Display limit (star lists)
type: number
default: 2
min: 1
max: 100
- # Number of repositories to display per star lists
plugin_starlists_limit_repositories:
- description: Number of repositories to display per star lists
+ description: Display limit (repositories per star list)
type: number
default: 2
min: 0
max: 100
- # Shuffle displayed repositories for varied outputs
plugin_starlists_shuffle_repositories:
- description: Shuffle displayed repositories
+ description: Shuffle data for varied outputs
type: boolean
default: yes
- # List of star lists that will be ignored
plugin_starlists_ignored:
- description: Star lists to skip
+ description: Skipped star lists (case insensitive)
type: array
format: comma-separated
default: ""
example: đ list1, đĨŗ list2, ...
- # List of star lists to display
- # Using this option is equivalent of using "plugin_starlists_ignored" with all star lists but the ones listed
plugin_starlists_only:
- description: Star lists to display
+ description: |
+ Restrict display to specified star lists (case insensitive)
+
+ This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option
type: array
format: comma-separated
default: ""