Change description of notice.type in README.md

This commit is contained in:
Oliver Traber 2025-06-14 16:39:25 +00:00
parent 3b15ec5ea3
commit 4ed7e9d08b
Signed by: Bluemedia
GPG key ID: C0674B105057136C

View file

@ -20,7 +20,7 @@ The frontend tries to retrieve a configuration file named `config.json` from the
| `defaultExpandGroups` | Boolean specifying if groups should be expanded by default. | `false` | | `defaultExpandGroups` | Boolean specifying if groups should be expanded by default. | `false` |
| `defaultRefreshInterval` | Interval in seconds after which the API data and config is refreshed in the background by default. Can be changed by the user by selecting a value in the lower left corner of the page. Possible values: `10`, `30`, `60`, `120`, `300`, `600` | `60` | | `defaultRefreshInterval` | Interval in seconds after which the API data and config is refreshed in the background by default. Can be changed by the user by selecting a value in the lower left corner of the page. Possible values: `10`, `30`, `60`, `120`, `300`, `600` | `60` |
| `notice` | Optional configuration for a notice on the page. It can be used to provide further information about a current outage, for example. | `{}` | | `notice` | Optional configuration for a notice on the page. It can be used to provide further information about a current outage, for example. | `{}` |
| `notice.type` | Type of the notice. This determines the background color of the card. Possible values: `success`, `warning`, `error`, (not defined - uses the base color) | not defined | | `notice.type` | Type of the notice. This determines the background color of the card. Possible values: `success`, `warning`, `error`, not defined (same color as other cards) | not defined |
| `notice.title` | Title of the notice card. | `""` | | `notice.title` | Title of the notice card. | `""` |
| `notice.content` | Content text of the notice card. | `""` | | `notice.content` | Content text of the notice card. | `""` |
| `notice.createdAt` | Date and time the notice was created at. For example, use the format `yyyy-MM-dd hh:mm` | `""` | | `notice.createdAt` | Date and time the notice was created at. For example, use the format `yyyy-MM-dd hh:mm` | `""` |