doc(plugins/achievements): update

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: ""