diff --git a/source/plugins/wakatime/README.md b/source/plugins/wakatime/README.md
index 66420df6..43d3d57a 100644
--- a/source/plugins/wakatime/README.md
+++ b/source/plugins/wakatime/README.md
@@ -1,26 +1,28 @@
-### â° WakaTime plugin
-
-The *wakatime* plugin displays statistics from your [WakaTime](https://wakatime.com) account.
-
+
+
-
-đŦ Obtaining a WakaTime token
-
-Create a [WakaTime account](https://wakatime.com) and retrieve your API key in your [Account settings](https://wakatime.com/settings/account).
-
-
-
-Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
-
-
-
-#### âĄī¸ Available options
+## âĄī¸ Available options
@@ -29,7 +31,7 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
plugin_wakatime |
- Display WakaTime stats
+ | Enable wakatime plugin
![]() |
@@ -49,7 +51,7 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
plugin_wakatime_days |
- WakaTime time range
+ | Time range
![]() |
@@ -60,7 +62,18 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
plugin_wakatime_sections |
- Sections to display
+ | Displayed sections
+
+time: show total coding time and daily average
+projects: show most time spent project
+projects-graphs: show most time spent projects graphs
+languages: show most language
+languages-graphs: show languages graphs
+editors: show most used code editor
+editors-graphs: show code editors graphs
+os: show most used operating system
+os-graphs: show code operating systems graphs
+
![]() |
@@ -71,7 +84,7 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
plugin_wakatime_limit |
- Maximum number of entries to display per graph
+ | Display limit (per graph)
![]() |
@@ -79,11 +92,13 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
(0 â¤
đĨ)
+zero behaviour: disable
default: 5
plugin_wakatime_url |
- Address where to reach your Wakatime instance
+ | WakaTime url
+Also compatible with self-hosted instance (wakapi)
![]() |
@@ -93,7 +108,7 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
plugin_wakatime_user |
- Your Wakatime user on the selfhosted Wakapi instance
+ | WakaTime username
![]() |
@@ -104,9 +119,15 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
-*[â Full specification](metadata.yml)*
+## đī¸ Obtaining a WakaTime token
-#### âšī¸ Examples workflows
+Create a [WakaTime account](https://wakatime.com) and retrieve API key in [Account settings](https://wakatime.com/settings/account).
+
+
+
+Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go!
+
+## âšī¸ Examples workflows
```yaml
diff --git a/source/plugins/wakatime/metadata.yml b/source/plugins/wakatime/metadata.yml
index c53af6e8..1b4a34d6 100644
--- a/source/plugins/wakatime/metadata.yml
+++ b/source/plugins/wakatime/metadata.yml
@@ -1,71 +1,75 @@
name: "â° WakaTime plugin"
category: social
+description: This plugin displays statistics from your [WakaTime](https://wakatime.com) account.
+examples:
+ default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.wakatime.svg
index: 7
supports:
- user
scopes: []
inputs:
- # Enable or disable plugin
plugin_wakatime:
- description: Display WakaTime stats
+ description: Enable wakatime plugin
type: boolean
default: no
- # WakaTime API token
- # See https://wakatime.com/settings/account get your API key
plugin_wakatime_token:
description: WakaTime API token
type: token
default: ""
- # Time range to use for displayed stats
plugin_wakatime_days:
- description: WakaTime time range
+ description: Time range
type: string
values:
- - 7 # Last week
- - 30 # Last month
- - 180 # Last 6 months
- - 365 # Last year
+ - 7
+ - 30
+ - 180
+ - 365
default: 7
- # Sections to display
plugin_wakatime_sections:
- description: Sections to display
+ description: |
+ Displayed sections
+ - `time`: show total coding time and daily average
+ - `projects`: show most time spent project
+ - `projects-graphs`: show most time spent projects graphs
+ - `languages`: show most language
+ - `languages-graphs`: show languages graphs
+ - `editors`: show most used code editor
+ - `editors-graphs`: show code editors graphs
+ - `os`: show most used operating system
+ - `os-graphs`: show code operating systems graphs
type: array
values:
- - time # Show total coding time and daily average
- - projects # Show most time spent project
- - projects-graphs # Show most time spent projects graphs
- - languages # Show most language
- - languages-graphs # Show languages graphs
- - editors # Show most used code editor
- - editors-graphs # Show code editors graphs
- - os # Show most used operating system
- - os-graphs # Show code operating systems graphs
+ - time
+ - projects
+ - projects-graphs
+ - languages
+ - languages-graphs
+ - editors
+ - editors-graphs
+ - os
+ - os-graphs
default: time, projects, projects-graphs, languages, languages-graphs, editors, os
- # Number of entries to display per graph
- # Set to 0 to disable limitations
plugin_wakatime_limit:
- description: Maximum number of entries to display per graph
+ description: Display limit (per graph)
type: number
default: 5
min: 0
+ zero: disable
- # If you use a selfhosted wakatime instance (wakapi)
- # that is publicly available place your url here
- #
- # If you use the public wakapi instance the url
- # would be https://wakapi.dev
plugin_wakatime_url:
- description: Address where to reach your Wakatime instance
+ description: |
+ WakaTime url
+
+ Also compatible with self-hosted instance ([wakapi](https://github.com/muety/wakapi))
type: string
default: https://wakatime.com
- # Username on Wakatime
plugin_wakatime_user:
- description: Your Wakatime user on the selfhosted Wakapi instance
+ description: WakaTime username
type: string
default: current