From ceec2943c2438c2e9d53b43bdcd8c4e9eeb98b98 Mon Sep 17 00:00:00 2001
From: 3wc <3wc.git@doesthisthing.work>
Date: Tue, 2 Mar 2021 18:38:35 +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 a98ed8b..de482b9 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,28 @@
 
 [![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/keycloak/status.svg)](https://drone.autonomic.zone/coop-cloud/keycloak)
 
-> https://www.keycloak.org
\ No newline at end of file
+[Keycloak](https://www.keycloak.org) + Coöp Cloud.
+
+<!-- metadata -->
+* **Category**: Apps
+* **Status**: ❷💛
+* **Image**: [`jboss/keycloak`](https://hub.docker.com/r/jboss/keycloak), ❶💚, upstream
+* **Healthcheck**: Yes
+* **Backups**: ?
+* **Email**: ❸🍎
+* **Tests**: ❷💛
+* **SSO**: N/A
+<!-- endmetadata -->
+
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`][abra]
+2. Deploy [`coop-cloud/traefik`][cc-traefik]
+3. `abra app new keycloak --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-traefik]: https://git.autonomic.zone/compose-stacks/traefik