From f88d4c0209c45ed0b2457eeaf07bc29b14eeba9a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thorben=20G=C3=BCnther?= <admin@xenrox.net>
Date: Thu, 11 Nov 2021 15:12:22 +0100
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5f5dfd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# 10man-api
+
+[![builds.sr.ht status](https://builds.xenrox.net/~xenrox/10man-api/commits/.build.yml.svg)](https://builds.xenrox.net/~xenrox/10man-api/commits/.build.yml?)
+
+Code for [10man](https://hub.xenrox.net/~xenrox/10man/) API.
+
+## Configuration
+
+Your config file should be placed at `/etc/10man-api/config`.
+
+```
+# Connection string for the database (required)
+connection-string postgresql://user:pass@localhost/db?sslmode=disable
+# Comma separated list of steamID64 for users that should become an admin
+admins STEAMID64_ADMIN1,STEAMID64_ADMIN2
+```
-- 
2.44.0