Expand and reorganise README

Author: outlyer-net

README.md

@@ -1,50 +1,88 @@
 ## Unofficial Multi-architecture Resilio Sync Docker files
 
-> **WARNING:** \
-> This is still somewhat volatile while I settle on how to
-handle these images, the tags in particular are being re-defined
-as I make small tweaks. Please keep it mind (everything should work, though).\
-I'll remove this warning once the repository stabilises.
+This is a fork of the official [Resilio Sync for Docker repository](https://github.com/bt-sync/sync-docker) with small changes to be used on all architectures supported by Resilio Sync.
 
-This is a fork of the official [Resilio Sync for Docker repository](https://github.com/bt-sync/sync-docker) with small changes to be used on the all architectures supported by Resilio Sync.
+### Running with Docker Compose
 
-This repository has just a few key differences compared to the upstream one:
+This is my recommended way of running.
 
-  1. A makefile is provided to generate the different `Dockerfile`s and images.
-  1. Multiple `Dockerfile`s are provided, one per arch. They are different from the official one in the way the image is built, to ease multi-architecture support, but the end structure is the same, except the License for Resilio Sync is also included in the image.
-  1. They're based on a _debian stable slim_ image instead of on an Ubuntu image.
+Edit `docker-compose/docker-compose.yml` to fit your needs, then:
 
-In practice they should work exactly the same as the official one.
+```shell
+cd docker-compose
+docker compose up -d
+```
 
-The `Dockerfile`s:
+### Running with Docker
 
-* `amd64.Dockerfile`: For AMD64 aka x86_64 aka x64 (64 bit PC)
-* `arm64.Dockerfile`: For ARM64 aka ARMv8 aka AArch64 (64 bit ARM)
-* `armhf.Dockerfile`: For armhf aka ARMv7 (and up), (32 bit ARM with hardware float support). Superseded by `arm64`.
-* `armle.Dockerfile`: For armle aka EABI ARM (ARMv5 and up), (32 bit ARM). Superseded by `armhf` and `arm64`. Docker Hub does not provided official support for this architecture. NOTE: This image isn't a part of the auto-selected architecture images (e.g. `resiliosync-multiarch:latest`), you'll have to use `resiliosync-multiarch:armle-latest` directly.
-* `i386.Dockerfile`: For i386 aka x86 aka IA-32 (32 bit PC). Superseded by `amd64`. Docker Hub does not provided official support for this architecture.
+See [upstream usage instructions](#usage) below, simple example:
+
+```shell
+docker run -d --name Sync \
+           -p 127.0.0.1:8888:8888 \
+           -p 55555/tcp \
+           -p 55555/udp \
+           -v ./data:/mnt/sync \
+           -v /etc/localtime:/etc/localtime:ro \
+           --restart always \
+           outlyernet/resiliosync-multiarch
+```
 
 ### Pulling the image from Docker Hub
 
 For the architectures included in the multiarch support (`amd64`, `armhf`, `arm64` and `i386`):
 
-    # docker pull outlyernet/resiliosync-multiarch
+```shell
+docker pull outlyernet/resiliosync-multiarch
+```
 
 which is equivalent to
 
-    # docker pull outlyernet/resiliosync-multiarch:latest
+```shell
+docker pull outlyernet/resiliosync-multiarch:latest
+```
 
 may also use the version tag:
 
-    # docker pull outlyernet/resiliosync-multiarch:2.6.3
+```shell
+docker pull outlyernet/resiliosync-multiarch:2.7.3
+```
 
 As of this writing images for ARMv5 or ARMv6 (`armle`) are excluded from the automatic architecture selection mechanism, since Docker Hub doesn't appear to distinguish them from ARMv7. For those use:
 
-    # docker pull outlyernet/resiliosync-multiarch:latest-armle
+```shell
+docker pull outlyernet/resiliosync-multiarch:latest-armle
+```
 
 or
 
-    # docker pull outlyernet/resiliosync-multiarch:2.6.3-armle
+```shell
+docker pull outlyernet/resiliosync-multiarch:2.6.3-armle
+```
+
+### Build instructions
+
+> **WARNING:** \
+> This is still somewhat volatile while I settle on how to
+handle these images, the tags in particular are being re-defined
+as I make small tweaks. Please keep it mind (everything should work, though).\
+I'll remove this warning once the repository stabilises.
+
+This repository has just a few key differences compared to the upstream one:
+
+  1. Multiple `Dockerfile`s are provided, one per arch. They are different from the official one in the way the image is built, to ease multi-architecture support, but the end structure is the same, except the License for Resilio Sync is also included in the image.
+  1. A makefile is provided to generate the different `Dockerfile`s and images.
+  1. They're based on a _debian stable slim_ image instead of on an Ubuntu image.
+
+In practice they should work exactly the same as the official one.
+
+The `Dockerfile`s:
+
+* `amd64.Dockerfile`: For AMD64 aka x86_64 aka x64 (64 bit PC)
+* `arm64.Dockerfile`: For ARM64 aka ARMv8 aka AArch64 (64 bit ARM)
+* `armhf.Dockerfile`: For armhf aka ARMv7 (and up), (32 bit ARM with hardware float support). Superseded by `arm64`.
+* `armle.Dockerfile`: For armle aka EABI ARM (ARMv5 and up), (32 bit ARM). Superseded by `armhf` and `arm64`. Docker Hub does not provided official support for this architecture. NOTE: This image isn't a part of the auto-selected architecture images (e.g. `resiliosync-multiarch:latest`), you'll have to use `resiliosync-multiarch:armle-latest` directly.
+* `i386.Dockerfile`: For i386 aka x86 aka IA-32 (32 bit PC). Superseded by `amd64`. Docker Hub does not provided official support for this architecture.
 
 ### Links