From a91b5279d8bebf2eef1df42365d054203b19e602 Mon Sep 17 00:00:00 2001
From: "Franz Heinzmann (Frando)" <frando@unbiskant.org>
Date: Thu, 29 Sep 2022 17:21:11 +0200
Subject: [PATCH] add docs

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4bd94f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# [Listmonk](https://listmonk.app/)
+
+[Listmonk](https://listmonk.app/) is a tool for e-mail campaigns and newsletters. [Source on GitHub](https://github.com/knadh/listmonk)
+
+<!-- metadata -->
+* **Category**: Development
+* **Status**: 1, alpha
+* **Image**: [`listmonk/listmonk`](https://hub.docker.com/r/listmonk/listmonk/), 2, upstream
+* **Healthcheck**: No
+* **Backups**: No
+* **Email**: ?
+* **Tests**: 2
+* **SSO**: No
+<!-- endmetadata -->
+
+## Basic usage
+
+1. Set up Docker Swarm and [`abra`][abra]
+2. Deploy [`coop-cloud/traefik`][cc-traefik]
+3. `abra app new listmonk --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. Nothing to change apart from the DOMAIN at the moment.
+5. `abra app YOURAPPDOMAIN deploy`
+