From 560ef975b2dbe3dd3efd33aaf8d0a3747771a4b8 Mon Sep 17 00:00:00 2001
From: Giovanni Harting <539@idlegandalf.com>
Date: Thu, 25 Nov 2021 21:41:43 +0100
Subject: [PATCH] Update 'README.md'

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 189c488..cd35ae0 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
-# alhp-mirrorlist
+# ALHP Mirrorlist
 
+Mirrors for [ALHP](https://git.harting.dev/ALHP/ALHP.GO).
+
+## Issues with current mirrors
+If some mirror is out of date or simply not reachable anymore, please [open an issue](https://git.harting.dev/ALHP/alhp-mirrorlist/issues/new).
+
+## How to become a Mirror
+
+### Mirroring via rsync
+
+**source**: `rsync://alhp.harting.dev/alhp`\
+**lastupdate**: `https://alhp.harting.dev/lastupdate`\
+**expected size**: around 30GB per `march` (e.g. *x86-64-v3*) you want to sync.
+
+I highly recommend using [this script from Archlinux](https://gitlab.archlinux.org/archlinux/infrastructure/-/blob/master/roles/syncrepo/files/syncrepo-template.sh) as base for a sync service. It checks if a sync needs to be done (by comparing *lastupdate* before syncing). It's also worth to read comments.
+
+You are free to mirror only some march or exclude `/logs`, [see line 90](https://gitlab.archlinux.org/archlinux/infrastructure/-/blob/a4a8a640d821acdb95e72770ea0632beffb28df9/roles/syncrepo/files/syncrepo-template.sh#L90) of said script above.
+
+If you have set up a new mirror, open a PR here in this repo adding your mirror to `mirrorlist` under the appropriate region.