From d80bdf03246c18d8021adbc3c63570b3cd0aa308 Mon Sep 17 00:00:00 2001
From: Andreas Stenius <git@astekk.se>
Date: Tue, 23 Feb 2021 13:59:14 +0100
Subject: [PATCH] badges: touch up readmes.

Signed-off-by: Andreas Stenius <git@astekk.se>
---
 .changeset/red-peas-smoke.md     |  6 ++++++
 plugins/badges-backend/README.md | 17 +++++++----------
 plugins/badges/README.md         | 12 +++++++++---
 3 files changed, 22 insertions(+), 13 deletions(-)
 create mode 100644 .changeset/red-peas-smoke.md

diff --git a/.changeset/red-peas-smoke.md b/.changeset/red-peas-smoke.md
new file mode 100644
index 0000000000..4640e12b48
--- /dev/null
+++ b/.changeset/red-peas-smoke.md
@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-badges': patch
+'@backstage/plugin-badges-backend': patch
+---
+
+New plugin to serve badges.
diff --git a/plugins/badges-backend/README.md b/plugins/badges-backend/README.md
index cbd2dcf0c7..ac85267ca1 100644
--- a/plugins/badges-backend/README.md
+++ b/plugins/badges-backend/README.md
@@ -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
diff --git a/plugins/badges/README.md b/plugins/badges/README.md
index 5e89e1294f..221d3a0e90 100644
--- a/plugins/badges/README.md
+++ b/plugins/badges/README.md
@@ -1,8 +1,14 @@
-# badges
+# Badges
 
-Welcome to the badges plugin!
+The badges plugin offers a set of badges that can be used outside of
+your backstage deployment, showing information related to data from
+the catalog, such as entity owner and lifecycle data for instance.
 
-_This plugin was created through the Backstage CLI_
+The available badges are setup in the `badges-backend` plugin, see
+link below.
+
+To get markdown code for the badges, access the `Badges` context menu
+(three dots in the upper right corner) of an entity page.
 
 ## Links