From 2cc445fd26d3eef9ce994b5067da6ebc104bad20 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 292bf48..e77bb29 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
-# invoiceninja
+# Invoiceninja
 
 > https://www.invoiceninja.org
+
+<!-- metadata -->
+* **Category**: Apps
+* **Status**: ❹💣
+* **Image**: [`invoiceninja/invoiceninja`](https://hub.docker.com/r/invoiceninja/invoiceninja), ❶💚, upstream
+* **Healthcheck**: No
+* **Backups**: No
+* **Email**: ?
+* **Tests**: No
+* **SSO**: ?
+<!-- endmetadata -->
+
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`][abra]
+2. Deploy [`coop-cloud/traefik`][traefik]
+3. `abra app new invoiceninja --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
+[traefik]: https://git.autonomic.zone/coop-cloud/traefik