From d6ff40acea2d4b29aaa8862720603e141aecc600 Mon Sep 17 00:00:00 2001
From: Victoria Nadasdi <victoria@efertone.me>
Date: Wed, 17 Apr 2024 00:16:37 +0200
Subject: [PATCH] add readme

Signed-off-by: Victoria Nadasdi <victoria@efertone.me>
---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0214914
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# Unofficial Phanpy Docker Image
+
+## Docker run
+
+```bash
+docker run ghcr.io/yitsushi/phanpy-docker:latest
+```
+
+## Docker Compose
+
+```yaml
+---
+version: "3.9"
+services:
+  phanpy:
+    image: ghcr.io/cheeaun/phanpy:latest
+    container_name: phanpy
+    ports:
+      - 8080:80
+```
+
+## An example on Docker Stack
+
+That's how I deployed on my swarm cluster:
+
+```yaml
+---
+version: '3.9'
+
+services:
+  stable:
+    image: ghcr.io/yitsushi/phanpy-docker:2024.04.04.65d51b0
+    networks:
+      - traefik-public
+    ports:
+      - 80
+    deploy:
+      labels:
+        - "homepage.group=Social"
+        - "homepage.icon=/icons/phanpy.png"
+        - "homepage.name=Phanpy"
+        - "homepage.href=https://phanpy.efertone.me/"
+        - "homepage.description=Alternative Mastodon Web Client"
+
+        - "traefik.enable=true"
+        - "traefik.http.routers.phanpy-efertone-me.rule=Host(`phanpy.efertone.me`)"
+        - "traefik.http.services.phanpy-efertone-me.loadbalancer.server.port=80"
+        - "traefik.http.routers.phanpy-efertone-me.tls=true"
+        - "traefik.http.routers.phanpy-efertone-me.tls.certresolver=cloudflare"
+        - "traefik.http.routers.phanpy-efertone-me.entryPoints=http,https"
+        - "traefik.docker.network=traefik-public"
+
+networks:
+  traefik-public:
+    external: true
+```