From 154a526262ca129875f2a3b8c85ae0fd7ee8162c Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Sat, 15 Jan 2022 21:58:30 -0500
Subject: [PATCH] doc(plugins/nightscout): update
---
source/plugins/nightscout/README.md | 63 +++++++++++++++-----------
source/plugins/nightscout/metadata.yml | 25 +++++-----
2 files changed, 48 insertions(+), 40 deletions(-)
diff --git a/source/plugins/nightscout/README.md b/source/plugins/nightscout/README.md
index ae39da2e..db9f66a5 100644
--- a/source/plugins/nightscout/README.md
+++ b/source/plugins/nightscout/README.md
@@ -1,22 +1,29 @@
-### đ Nightscout
-
-The *Nightscout* plugin lets you display blood sugar values from a [Nightscout](http://nightscout.info) site.
-
+
@@ -25,7 +32,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout |
- Displays Blood Glucose
+ | Enable nightscout plugin
![]() |
@@ -35,7 +42,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout_url |
- Your Nightscout site URL
+ | Nightscout URL
![]() |
@@ -45,7 +52,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout_datapoints |
- How many datapoints to show on the graph. 0 and 1 disable the graph.
+ | Number of datapoints shown the graph
![]() |
@@ -53,11 +60,12 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
(0 â¤
đĨ)
+zero behaviour: disable
default: 12
plugin_nightscout_lowalert |
- When the blood sugar is considered low
+ | Threshold for low blood sugar
![]() |
@@ -69,7 +77,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout_highalert |
- When the blood sugar is considered high
+ | Threshold for high blood sugar
![]() |
@@ -81,7 +89,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout_urgentlowalert |
- When the blood sugar is considered urgently low
+ | Threshold for urgently low blood sugar
![]() |
@@ -93,7 +101,7 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
plugin_nightscout_urgenthighalert |
- When the blood sugar is considered urgently high
+ | Threshold for urgently high blood sugar
![]() |
@@ -106,9 +114,12 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a
-*[â Full specification](metadata.yml)*
+## đ Setup a Nightscout instance
-#### âšī¸ Examples workflows
+The [nightscout website](http://www.nightscout.info/) details how to self-host a nightscout site.
+Check out the instructions there.
+
+## âšī¸ Examples workflows
```yaml
@@ -119,4 +130,4 @@ with:
plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}
```
-
\ No newline at end of file
+
diff --git a/source/plugins/nightscout/metadata.yml b/source/plugins/nightscout/metadata.yml
index c9609349..91018ffd 100644
--- a/source/plugins/nightscout/metadata.yml
+++ b/source/plugins/nightscout/metadata.yml
@@ -1,5 +1,8 @@
name: "đ Nightscout"
category: community
+description: This plugin lets you display blood sugar values from a [Nightscout](http://nightscout.info) site.
+examples:
+ default: https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg
authors:
- legoandmars
supports:
@@ -7,49 +10,43 @@ supports:
scopes: []
inputs:
- # Enable or disable plugin
plugin_nightscout:
- description: Displays Blood Glucose
+ description: Enable nightscout plugin
type: boolean
default: no
- # Nightscout site URL
plugin_nightscout_url:
- description: Your Nightscout site URL
+ description: Nightscout URL
type: string
default: https://example.herokuapp.com
- # Controls how big the graph is
plugin_nightscout_datapoints:
- description: How many datapoints to show on the graph. 0 and 1 disable the graph.
+ description: Number of datapoints shown the graph
type: number
default: 12
min: 0
+ zero: disable
- # Low value used for colors and text alerts
plugin_nightscout_lowalert:
- description: When the blood sugar is considered low
+ description: Threshold for low blood sugar
type: number
default: 80
min: 0
- # High value used for colors and text alerts
plugin_nightscout_highalert:
- description: When the blood sugar is considered high
+ description: Threshold for high blood sugar
type: number
default: 180
min: 0
- # Urgent low value used for colors and text alerts
plugin_nightscout_urgentlowalert:
- description: When the blood sugar is considered urgently low
+ description: Threshold for urgently low blood sugar
type: number
default: 50
min: 0
- # Urgent high value used for colors and text alerts
plugin_nightscout_urgenthighalert:
- description: When the blood sugar is considered urgently high
+ description: Threshold for urgently high blood sugar
type: number
default: 250
min: 0