From 6ef97ec62f4328f14e04486602bd1d454b7f89ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20Molakvo=C3=A6?= <skjnldsv@users.noreply.github.com>
Date: Mon, 9 Sep 2024 12:54:55 +0200
Subject: [PATCH] Create README.md

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..df596d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+## A linuxserver plex image that supports AMD transcoding
+
+Easy as it sounds, just see the linuxserver docs: https://docs.linuxserver.io/images/docker-plex/
+
+Use the image `ghcr.io/skjnldsv/docker-plex:master`.
+Also make sure you pass your amd device like so:
+
+```yml
+    devices:
+      - /dev/dri:/dev/dri
+```
+
+### Full example
+```yml
+version: "3.7"
+
+services:
+  plex:
+    image: ghcr.io/skjnldsv/docker-plex:master
+    restart: unless-stopped
+    container_name: plex
+
+    ports:
+
+      # Default access
+      - target: 32400
+        published: 32400
+        mode: host
+ 
+      # https://support.plex.tv/articles/201543147-what-network-ports-do-i-need-to-allow-through-my-firewall/
+      # Plex Home Theater control
+      - 8324:8324/tcp
+
+      # GDM discovery
+      - 32410:32410/udp
+      - 32412:32412/udp
+      - 32413:32413/udp
+      - 32414:32414/udp
+
+    environment:
+      - TZ=Europe/Berlin
+      - VERSION=docker
+
+    devices:
+      - /dev/dri:/dev/dri
+    volumes:
+      - /mnt/config:/config
+      - /mnt/storage:/storage
+```