From 2951a93294c81872d2a6080ab285d322019f40fc Mon Sep 17 00:00:00 2001
From: Michael Ochmann <michael.ochmann@propeller.de>
Date: Sat, 4 Jan 2025 01:25:28 +0100
Subject: [PATCH] added more info to `README.md`

---
 README.md          | 33 +++++++++++++++++++++++++++++++--
 docker-compose.yml |  3 +--
 2 files changed, 32 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 16b8025..36f6325 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,36 @@ router. Currently it is deployed as an open and free tracker instance. Read our
 free and open tracker blog and announce your torrents there *(but do not
 hesitate to setup your own free trackers!)*.
 
-This is a dockerized version of this software made by [erdgeist][erdgeist]
+This is a dockerized version of this software made by [erdgeist][erdgeist].
 
-### License
+## Usage
+The easiest method is to use the *ready-to-use* image from dockerhub, using `docker compose`. Create a file called `docker-compose.yml` and add the following content:
+
+```yaml
+services:
+  opentracker:
+    container_name: opentracker
+    image: mikognn/opentracker
+    ports:
+      - 6969:6969
+    volumes:
+      - ./config:/config
+```
+
+then create a `config` directory in the same folder as the `.yml` file and add the `opentracker.conf`. You can find a fully fletched *(and documented)* version of it in the [`opentracker.conf.sample`][config] file.
+
+### Build it yourself
+You can also clone my [repo][repo] and run `docker compose up` from within. This will build the container on your machine.
+
+Just run
+```bash
+	git clone --recursive https://git.mike-ochmann.de/miko/opentracker.git
+	cd opentracker
+	cp config/opentracker.conf.sample config/opentracker.conf
+	sudo docker compose up -d
+```
+
+## License
 The license is not really clear to me. It may be GPL or "beer ware license" or
 a combination of both. I will not really give any license information because
 of that.
@@ -16,3 +43,5 @@ of that.
 [torrent]: http://wiki.theory.org/BitTorrentSpecification
 [erdgeist]: https://erdgeist.org/about/
 [opentracker]: https://erdgeist.org/arts/software/opentracker/
+[config]: https://erdgeist.org/gitweb/opentracker/tree/opentracker.conf.sample
+[repo]: https://git.mike-ochmann.de/miko/opentracker
\ No newline at end of file
diff --git a/docker-compose.yml b/docker-compose.yml
index 1b6f8da..9dc8f33 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,7 +1,6 @@
-version: "3"
-
 services:
   opentracker:
+    container_name: opentracker
     build: .
     ports:
       - 6969:6969