cybercinch/dynamic-badges-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

📝 Improve documentation

Browse Source
This commit is contained in:
Simon Schneegans
2022-04-18 13:50:35 +02:00
parent 6511e529e9
commit a3f7e7f029
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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.

8
action.yml
View File

@@ -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.'