diff --git a/source/plugins/traffic/README.md b/source/plugins/traffic/README.md index 354a90b7..950d4a92 100644 --- a/source/plugins/traffic/README.md +++ b/source/plugins/traffic/README.md @@ -1,20 +1,28 @@ -### 🧮 Repositories traffic - -> âš ī¸ This plugin requires a personal token with repo scope. - -The repositories *traffic* plugin displays the number of page views across your repositories. - + - + + + + + + + + + + + + + + +
- -

🧮 Repositories traffic

This plugin displays the number of page views across your repositories.

+
Supported features
→ Full specification
📗 Classic template 📘 Repository template 📙 Terminal template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 repo read:org (optional) read:user (optional)
+ + +
+ -Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations. - -![Token with repo scope](/.github/readme/imgs/setup_token_repo_scope.png) - -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -23,7 +31,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope - @@ -33,7 +41,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope - @@ -45,9 +53,7 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope
plugin_traffic

Display repositories traffic metrics

+

Enable traffic plugin

plugin_traffic_skipped

Repositories to skip

+

Skipped repositories

-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -60,4 +66,4 @@ with: plugin_traffic: 'yes' ``` - \ No newline at end of file + diff --git a/source/plugins/traffic/metadata.yml b/source/plugins/traffic/metadata.yml index d058db49..5a14ddb3 100644 --- a/source/plugins/traffic/metadata.yml +++ b/source/plugins/traffic/metadata.yml @@ -1,5 +1,8 @@ name: "🧮 Repositories traffic" category: github +description: This plugin displays the number of page views across your repositories. +examples: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg index: 19 supports: - user @@ -9,15 +12,13 @@ scopes: - repo inputs: - # Enable or disable plugin plugin_traffic: - description: Display repositories traffic metrics + description: Enable traffic plugin type: boolean default: no - # List of repositories that will be skipped plugin_traffic_skipped: - description: Repositories to skip + description: Skipped repositories type: array format: comma-separated default: ""