From df9f34e3b0bcdca8f0bd72e4d472b8a70e4c4f2c Mon Sep 17 00:00:00 2001
From: moshferatu <gitea@steveharris.sh>
Date: Thu, 14 Mar 2024 04:42:53 -0700
Subject: [PATCH] Add README file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f38cb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# Docker Compose
+
+This repository contains Docker Compose files for setting up and running various services.
+
+Each service has its own YAML file which defines the configuration for that service.
+
+## Services
+
+- [Backtest Automation](./backtest-automation.yaml)
+- [Caddy](./caddy.yaml)
+- [Cloudflare Tunnel](./cloudflare-tunnel.yaml)
+- [Download SPX Quotes](./download-spx-quotes.yaml)
+- [Gitea](./gitea.yaml)
+- [IBKR Gateway](./ibkr-gateway.yaml)
+- [Immich](./immich.yaml)
+- [Jellyfin](./jellyfin.yaml)
+- [Jellyseer](./jellyseer.yaml)
+- [Navidrome](./navidrome.yaml)
+- [Pi-hole](./pi-hole.yaml)
+- [PostgreSQL](./postgresql.yaml)
+- [Process Over Profit Bot](./process-over-profit-bot.yaml)
+- [Prowlarr](./prowlarr.yaml)
+- [Radarr](./radarr.yaml)
+- [SABnzbd](./sabnzbd.yaml)
+- [Sonarr](./sonarr.yaml)
+- [Syncthing](./syncthing.yaml)
+- [Update News Data](./update-news-data.yaml)
+- [Update OHLC Data](./update-ohlc-data.yaml)
+
+## Running Services
+
+To run a service, navigate to the directory containing the Docker Compose file for that service and run the following command:
+
+```sh
+docker-compose -f <file.yaml> up -d
+```
+
+Replace <file.yaml> with the name of the Docker Compose file for the service you want to run.
+
+## Important Note
+
+Before running any service, make sure to replace all placeholder values in the Docker Compose files with actual values.
+
+These placeholders are denoted by <...> in the files.
\ No newline at end of file