Skip to content

Commit

Permalink
📝 Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Schneegans committed Apr 18, 2022
1 parent 6511e52 commit a3f7e7f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.'
Expand Down

0 comments on commit a3f7e7f

Please sign in to comment.