badges: touch up readmes.

Signed-off-by: Andreas Stenius <git@astekk.se>
This commit is contained in:
Andreas Stenius
2021-02-23 13:59:14 +01:00
committed by Fredrik Adelöw
parent 0f30b99bc2
commit d80bdf0324
3 changed files with 22 additions and 13 deletions
+7 -10
View File
@@ -6,24 +6,21 @@ the badges, in svg.
## Setup
Define which badges to offer in the backend api by declaring them in
the app-config, under a `badges` key. Example:
The list of all badges to offer are passed to the badges-backend
`createRouter()`.
You may also add/redefine badges in the `app-config.yaml`, under a
`badges` key. Example:
```yaml
badges:
docs:
kind: 'entity'
target: '_{entity_url}/docs'
label: 'Documentation'
label: 'docs'
message: '_{entity.metadata.name}'
color: 'navyblue'
lifecycle:
kind: 'entity'
description: 'Entity lifecycle badge'
target: '_{entity_url}'
label: 'Lifecycle'
message: '_{entity.spec.lifecycle}'
style: for-the-badge
```
## Links