From 6c1ce017cdd0912c7b40230ef8627f07c8cbfdc8 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 19:25:01 -0500 Subject: [PATCH] doc(plugins/achievements): update --- source/plugins/achievements/README.md | 76 ++++++++++++------------ source/plugins/achievements/metadata.yml | 49 ++++++++------- 2 files changed, 67 insertions(+), 58 deletions(-) diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index 49f02b74..481e5811 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -1,33 +1,29 @@ -### 🏆 Achievements - -The *achievements* plugin displays several highlights about what you achieved on GitHub. - + - + + + + + + + + + + + + + + +
-
Compact display - -
-
Detailed display - -
- -

🏆 Achievements

This plugin displays several highlights about what you achieved on GitHub.

+
Supported features
→ Full specification		📗 Classic template
👤 Users đŸ‘Ĩ Organizations
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
Compact display
+
Detailed display
+ +
+ -Achievements are mostly related to features offered by GitHub, so by unlocking achivements ranks you'll be mastering GitHub in no time! - -A few achievements contains actual real ranking (based on [GitHub search](https://github.com/search) results)! - -**About achievements ranks** - -Moving forward between ranks is voluntarily difficult, making it almost impossible to reach the latest rank except by hard work. - -With this design, when a user reach upper ranks you can be sure that they really deserve it! -It also lets you quickly see at a glance what this user primarly use GitHub for, just look for crimson and gold badges! - -![Ranks](/.github/readme/imgs/plugin_achievements_ranks.png) - -#### ➡ī¸ Available options +## ➡ī¸ Available options @@ -36,7 +32,7 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -46,7 +42,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -57,7 +54,7 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -67,7 +64,11 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -78,7 +79,7 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -90,7 +91,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -100,7 +102,9 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, - @@ -111,9 +115,7 @@ It also lets you quickly see at a glance what this user primarly use GitHub for,
plugin_achievements

Display achievements

+

Enable achievements plugin
plugin_achievements_threshold

Display rank minimal threshold

+

Display rank threshold

+

Use X to display achievements not yet unlocked
plugin_achievements_secrets

Display unlocked secrets achievements

+

Display secrets achievements
plugin_achievements_display

Achievements display style

+

Display style

+
    +
  • detailed: display icon, name, description and ranking
    • +
  • compact: display icon, name and value
    • +
plugin_achievements_limit

Maximum number of achievements to display

+

Display limit
plugin_achievements_ignored

Unlocked achievements to hide

+

Hide specified achievements

+

Use names without the rank adjective (i.e. without "great", "super" or "master")
plugin_achievements_only

Unlocked achievements to display

+

Restrict display to specified achievements

+

Use names without the rank adjective (i.e. without "great", "super" or "master")

+

This option is equivalent to plugin_achievements_ignored with all existing achievements but the ones listed in this option
-*[→ Full specification](metadata.yml)* - -#### ℹī¸ Examples workflows +## ℹī¸ Examples workflows ```yaml diff --git a/source/plugins/achievements/metadata.yml b/source/plugins/achievements/metadata.yml index e97f5b73..0fba52b6 100644 --- a/source/plugins/achievements/metadata.yml +++ b/source/plugins/achievements/metadata.yml @@ -1,5 +1,9 @@ name: "🏆 Achievements" category: github +description: This plugin displays several highlights about what you achieved on GitHub. +examples: + +compact display: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.achievements.compact.svg + detailed display: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.achievements.svg index: 14 supports: - user @@ -8,15 +12,16 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_achievements: - description: Display achievements + description: Enable achievements plugin type: boolean default: no - # Minimal rank to display plugin_achievements_threshold: - description: Display rank minimal threshold + description: | + Display rank threshold + + Use `X` to display achievements not yet unlocked type: string default: C values: @@ -24,45 +29,47 @@ inputs: - A - B - C - - X # Not unlocked + - X - # Display secrets achievements unlocked plugin_achievements_secrets: - description: Display unlocked secrets achievements + description: Display secrets achievements type: boolean default: yes - # Achievements display style plugin_achievements_display: - description: Achievements display style + description: | + Display style + - `detailed`: display icon, name, description and ranking + - `compact`: display icon, name and value type: string default: detailed values: - - detailed # Detailed display - - compact # Compact display (only icon, name and value are displayed) + - detailed + - compact - # Number of achievements events to display - # Set to 0 to disable limitations plugin_achievements_limit: - description: Maximum number of achievements to display + description: Display limit type: number default: 0 min: 0 - # List of unlocked achievements to hide - # Names must be given in lower case, without rank adjective plugin_achievements_ignored: - description: Unlocked achievements to hide + description: | + Hide specified achievements + + Use names without the rank adjective (i.e. without "great", "super" or "master") type: array format: comma-separated default: "" example: octonaut, automator, explorer - # List of unlocked achievements to display - # Names must be given in lower case, without rank adjective - # Using this option is equivalent of using "plugin_achievements_ignored" with all existing achievements but the ones listed plugin_achievements_only: - description: Unlocked achievements to display + description: | + Restrict display to specified achievements + + Use names without the rank adjective (i.e. without "great", "super" or "master") + + This option is equivalent to `plugin_achievements_ignored` with all existing achievements but the ones listed in this option type: array format: comma-separated default: ""