readme

1 files changed, 49 insertions, 8 deletions

diff --git a/Readme.md b/Readme.md
index 46b4284..996f14a 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,7 +1,55 @@
 # AUR PKG Builder
 
-Automated AUR package buildsystem.
+Automated AUR package buildsystem built on Podman capable of resolving AUR dependecies.
 
+## Usage
+
+In normal operation, no intervention should be required.
+See **Configuration** and **Installation** for Instruction on setup.
+
+Builds can be manually triggered by `systemctl start aurbuilder-package.service`.
+This requires a `aurbuilder-container.service` run to have completed beforehand.
+
+The repository index can be force-updated with `systemctl start aurbuilder-repo.service`.
+
+## Client pacman Configuration
+
+```ini
+[<repo name>]
+Server = http://aurbuilder.example.com/
+SigLevel = Optional TrustAll
+```
+
+## Configuration
+
+### Packages to build
+
+To build, the *exact* name has to be added in a new line `/etc/aurbuilder/packages`.
+It will be included in the next run.
+
+**CAUTION:** Packages removed from this list will *NOT* be automatically deleted.
+It is possible for old (possibly insecure) builds to linger around.
+Delete them manually for now.
+
+### Build settings
+
+General settings are stored in `/etc/aurbuilder/config`.
+
+#### `FORCE_REBUILD`
+
+`yes/[no]`
+
+All packages will be rebuilt every run
+
+#### `PACKAGER`
+
+Name and mail of the packager to be stored in the packages.
+Format: `Na Me <name@mail.com>`
+
+#### `REPONAME`
+
+The name to be used for the package database.
+This has to match with the repositories name in `pacman.conf`.
 
 ## Installation
 
@@ -12,13 +60,6 @@ Enable the systemd timers to activate the automated builds:
 `systemctl enable aurbuilder-container.timer` and
 `systemctl enable aurbuilder-package.timer`.
 
-## Usage
-
-Add packages to build in `/etc/aurbuilder/packages` (one per line).
-
-Builds can be manually triggered by `systemctl start aurbuilder-package.service`.
-This requires a `aurbuilder-container.service` run to have completed beforehand.
-
 ## Locations
 
 | location | description |