From db795ab110a658556f0315370f945c5501a6e64c Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 11:51:09 -0500 Subject: [PATCH] docs(plugins/isocalendar): full rewrite --- source/plugins/isocalendar/README.md | 50 ++----------------------- source/plugins/isocalendar/metadata.yml | 10 +++-- 2 files changed, 10 insertions(+), 50 deletions(-) diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 2698143b..3eff2a87 100644 --- a/source/plugins/isocalendar/README.md +++ b/source/plugins/isocalendar/README.md @@ -1,54 +1,12 @@ -### 📅 Isometric commit calendar + + -The *isocalendar* plugin displays an isometric view of your commits calendar, along with a few additional stats like current streak and commit average per day. - - - -
-
Full year isometric calendar - -
-
Half year isometric calendar - -
- -
- -#### âžĄī¸ Available options +## âžĄī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_isocalendar` | `boolean` **[no]** | Display an isometric view of your commits calendar | -| `plugin_isocalendar_duration` | `string` **[half-year]** *{"half-year", "full-year"}* | Set time window shown by isometric calendar | - - -*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows -```yaml -name: Half-year calendar -uses: lowlighter/metrics@latest -with: - filename: metrics.plugin.isocalendar.svg - token: ${{ secrets.METRICS_TOKEN }} - base: '' - plugin_isocalendar: 'yes' - -``` -```yaml -name: Full-year calendar -uses: lowlighter/metrics@latest -with: - filename: metrics.plugin.isocalendar.fullyear.svg - token: ${{ secrets.METRICS_TOKEN }} - base: '' - plugin_isocalendar: 'yes' - plugin_isocalendar_duration: full-year - -``` diff --git a/source/plugins/isocalendar/metadata.yml b/source/plugins/isocalendar/metadata.yml index da6101d6..a142b53f 100644 --- a/source/plugins/isocalendar/metadata.yml +++ b/source/plugins/isocalendar/metadata.yml @@ -1,5 +1,9 @@ name: "📅 Isometric commit calendar" category: github +description: This plugin displays an isometric view of your commit calendar along with a few additional statistics like current streak and average number of commit per day. +examples: + full year calendar: https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.fullyear.svg + half year calendar: https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg index: 0 supports: - user @@ -7,15 +11,13 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_isocalendar: - description: Display an isometric view of your commits calendar + description: Enable isocalendar plugin type: boolean default: no - # Set time window shown by isometric calendar plugin_isocalendar_duration: - description: Set time window shown by isometric calendar + description: Time window type: string default: half-year values: