readme

README.md

@@ -1,2 +1,20 @@
 # mirrord
-mirror
+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
+```