From 43452c7c14629dd50b8d60e3a7d4feac398810a1 Mon Sep 17 00:00:00 2001
From: JMARyA <jmarya@hydrar.de>
Date: Wed, 10 Apr 2024 11:41:36 +0200
Subject: [PATCH] readme

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

diff --git a/README.md b/README.md
index c463388..1f25b81 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
 # mirrord
-mirror
\ No newline at end of file
+mirrord is a local http mirror. It redirects every request it gets to mirror hosts and caches the response locally.
+
+## Using with pacman
+Configure mirrord to act as a pacman mirror:
+```toml
+mirrors = [
+    "https://mirror.leaseweb.net",
+    "https://archlinux.thaller.ws",
+    ...
+]
+
+cache_dir = "./data"
+no_cache = '.*(?:db|db\.sig)$'
+```
+
+Add this to your mirrorlist:
+```
+Server = http://<mirrord_host>:8080/archlinux/$repo/os/$arch
+```
\ No newline at end of file