From a3f7e7f029835b05f42a5d16d01ef28a4c46cdec Mon Sep 17 00:00:00 2001 From: Simon Schneegans Date: Mon, 18 Apr 2022 13:50:35 +0200 Subject: [PATCH] :memo: Improve documentation --- README.md | 8 ++++---- action.yml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5cda8af..2dbe6bc 100644 --- a/README.md +++ b/README.md @@ -94,10 +94,10 @@ For this, the following parameters can be used. Parameter | Description ----------|------------ -`valColorRange` | A numerical value used to define the message color. Usually this should be between `maxColorRange` and `minColorRange`. -`maxColorRange` | If `valColorRange` assumes this value, the badge will be green. -`minColorRange` | If `valColorRange` assumes this value, the badge will be red. -`invertColorRange` | If the range should be inverted, causing a smaller value to have green color. +`valColorRange` | A numerical value used to define the message color. Usually this should be between `maxColorRange` and `minColorRange`. This is required if you want to use the color range feature. +`maxColorRange` | If `valColorRange` assumes this value, the badge will be green. This is required if you want to use the color range feature. +`minColorRange` | If `valColorRange` assumes this value, the badge will be red. This is required if you want to use the color range feature. +`invertColorRange` | If the range should be inverted, causing a smaller value to have green color. Defaults to `false`. `colorRangeSaturation` | Saturation used by the color range feature. Defaults to 100. `colorRangeLightness` | Lightness used by the color range feature. Defaults to 40. diff --git a/action.yml b/action.yml index 4357187..f4247a5 100644 --- a/action.yml +++ b/action.yml @@ -50,16 +50,16 @@ inputs: description: 'The cache lifetime in seconds (must be greater than 300)' required: false valColorRange: - description: 'A numerical value used to define the message color. Usually this should be between maxColorRange and minColorRange.' + description: 'A numerical value used to define the message color. Usually this should be between maxColorRange and minColorRange. This is required if you want to use the color range feature.' required: false maxColorRange: - description: 'If valColorRange assumes this value, the badge will be green.' + description: 'If valColorRange assumes this value, the badge will be green. This is required if you want to use the color range feature.' required: false minColorRange: - description: 'If valColorRange assumes this value, the badge will be red.' + description: 'If valColorRange assumes this value, the badge will be red. This is required if you want to use the color range feature.' required: false invertColorRange: - description: 'If the range should be inverted, causing a smaller value to have green color.' + description: 'If the range should be inverted, causing a smaller value to have green color. Defaults to false.' required: false colorRangeSaturation: description: 'Saturation used by the color range feature. Defaults to 100.'