Update Readme.md

add more documentation

Readme.md

@@ -1,3 +1,5 @@
+__INFO: preliminary documentation ... more to come__
+
 # Overview
 
 This is an all in one pages server for [Gitea](https://gitea.com). With default settings it works and uses similar/same conventions as [Github Pages](https://pages.github.com).
@@ -6,10 +8,103 @@ You can operate it in 2 modes, either __simple__ (default) or __classic__ (simil
 
 In __simple__ mode no special DNS setup is required and the access to the hosted sides are always according to the pattern __http(s)://<your-server-hostname>/<organization>/<repository>__ 
 
-In __classic__ mode the access to the pages goes according to these two patterns: __http(s)://<organization>.<your-server-hostname>/<repository>__ or __http(s)://<organization>.<your-server-hostname>__ (with default configuration this serves the content of the repo named __<organization>.github.io__ of the organization)
+In __classic__ mode the access to the pages goes according to these two patterns: __http(s)://<organization>.<your-server-hostname>/<repository>__ or __http(s)://<organization>.<your-server-hostname>__ (with default configuration this serves the content of the repo named __<organization>.github.io__ of the organization) This requires that you setup a wildcard CNAME in DNS for your gitea host (see below for more details). You also need a wildcard HTTPS certificate if you want to run with HTTPS.
 
-It is realized as a plugin for [Caddy v2](https://github.com/caddyserver/caddy).
+# Usage
 
+To run the server in __simple__ mode you need a minimal configuration (filename _Caddyfile_) like this (replace _your-gitea-server_ and _gitea_access_token_):
+
+```Caddyfile
+{
+	order gitea-pages before file_server
+}
+:8080
+gitea-pages {
+	server https://your-gitea-server
+	token gitea-access-token
+}
+```
+
+
+Afterward you can simply run:
+
+```bash
+./caddy run --config Caddyfile
+```
+
+## Configuration
+
+These are the possible configuration options with their defaults:
+
+```Caddyfile
+{
+	order gitea-pages before file_server
+}
+:8080
+gitea-pages {
+	server https://your-gitea-server
+	token gitea-access-token
+        pages_branch gh-pages
+        postfix_pages_repository github.io
+        url_scheme simple
+}
+log {
+	level debug
+}
+```
+
+For __url_scheme__ defines the operation mode, it accepts _simple_ and _classic_.
+
+# Development
+
+The project is implemented as an extension for [Caddy](https://github.com/caddyserver/caddy) .
+More details can be found at: https://caddyserver.com/docs/extending-caddy
+
+## Build
+To build the server `xcaddy` need to be installed.
+
+```bash
+# Installing xcaddy
+go install github.com/caddyserver/xcaddy/cmd/xcaddy@latest
+```
+
+To build the server binary simply run
+
+```bash
+# Build a specific version
+xcaddy build --with github.com/simongregorebner/caddy-gitea@v0.0.1
+
+# Build with specific commit (that was pushed to github)
+xcaddy build --with github.com/simongregorebner/caddy-gitea@f4a6a77
+
+# Build locally
+xcaddy build --with github.com/simongregorebner/caddy-gitea=.
+```
+
+## Docker
+To build the server and create a docker image you can use:
+
+```bash
+docker build -t gitea-pages .
+
+# cross platform build
+docker build --platform=linux/amd64 -t gitea-pages .
+```
+
+## Testing
+
+If you are running/testing the server in __simple__ mode:
+```bash
+curl "http://localhost:8080/<organization>/<repository>[/index.html | /<path>]"
+```
+
+If running in __classic__ mode:
+```bash
+# testing organization repo
+curl -H "Host: <organisation>.<your testserver name>" "http://localhost:8080/"
+# testing a specific repo of the organization
+curl -H "Host: <organisation>.<your testserver name>" "http://localhost:8080/<repository>"
+```
 
 # Acknowledgements