From d8ba9aebc2aeec858b249b36c17f3537038e2211 Mon Sep 17 00:00:00 2001
From: dnomd343 <dnomd343@gmail.com>
Date: Sun, 26 Jun 2022 21:41:18 +0800
Subject: [PATCH] docs: add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2818450
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+## Quick Start
+
+Start a syncplay service, default at port tcp/8999.
+
+```bash
+docker run -d \
+--net=host \
+--name=syncplay \
+-e PORT=<PORT> \
+-e PASSWORD=<PASSWORD> \
+dnomd343/syncplay
+```
+
+If TLS is enabled, you have to set hostname and certificate folder
+
+```bash
+docker run -d \
+--net=host \
+--name=syncplay \
+--hostname=syncplay.your.domain
+-e PORT=<PORT> \
+-e PASSWORD=<PASSWORD> \
+-e TLS=/certs \
+-v <certs>:/certs \
+dnomd343/syncplay
+```