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

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

diff --git a/README.md b/README.md
index 2e516f1..94d92b4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
-# gitea
+# Gitea
 
 [![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/gitea/status.svg)](https://drone.autonomic.zone/coop-cloud/gitea)
+
+<!-- metadata -->
+* **Category**: Development
+* **Status**: ❷💛
+* **Image**: [`gitea/gitea`](https://hub.docker.com/gitea/gitea), ❶💚, upstream
+* **Healthcheck**: Yes
+* **Backups**: No
+* **Email**: ?
+* **Tests**: ❷💛
+* **SSO**: ❶💚 (OAuth)
+<!-- endmetadata -->
+
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`][abra]
+2. Deploy [`coop-cloud/traefik`][cc-traefik]
+3. `abra app new gitea --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`