From 786aafdb6ce762093884446cbe2465fabec2a1aa Mon Sep 17 00:00:00 2001
From: 3wc <3wc.git@doesthisthing.work>
Date: Tue, 2 Mar 2021 18:38:41 +0200
Subject: [PATCH] Follow new exciting README standard

See coop-cloud/organising#31
---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index edabf5f..7d8b0fe 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,31 @@
-# renovate-bot
+# Renovate Bot
 
 [![Build Status](https://drone.autonomic.zone/api/badges/autonomic-cooperative/renovate-bot/status.svg)](https://drone.autonomic.zone/autonomic-cooperative/renovate-bot)
 
 A robot who upgrades our configurations.
 
 See [config.js](./config.js.tmpl) for the configured repositories.
+
+<!-- metadata -->
+* **Category**: Development
+* **Status**: ?
+* **Image**: [`renovate/renovate`](https://hub.docker.com/r/renovate/renovate), ❶💚, upstream
+* **Healthcheck**: No
+* **Backups**: ?
+* **Email**: ?
+* **Tests**: ❷💛
+* **SSO**: ?
+<!-- endmetadata -->
+
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`][abra]
+2. Deploy [`coop-cloud/traefik`][cc-traefik]
+3. `abra app new renovate-bot --secrets` (optionally with `--pass` if you'd like
+   to save secrets in `pass`)
+4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
+   your Docker swarm box
+5. `abra app YOURAPPDOMAIN deploy`
+
+[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
+[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik