From 3818093ae9114989a9dbb90a8968a04484353b8a Mon Sep 17 00:00:00 2001
From: AngrySoundTech <angrysoundtech@gmail.com>
Date: Wed, 13 Mar 2024 16:48:03 -0400
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..4c265e7ad
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Civ
+
+This monorepo will eventually contain all civ projects and development
+
+## Developing Locally
+
+### Plugins
+
+### Containers
+A docker compose stack is provided to help test containers built from
+this repo. To start the stack, run the following command:
+`docker compose up --build`. Please note that this stack is NOT suitable for production use.
+
+Optional services may be started by enabling the profile flag, e.g. `--profile <name>`
+
+Current services and exposed ports are:
+
+| Name     | Ports     | Profile    |
+|----------|-----------|------------|
+| pvp      |           |            |
+| mariadb  | TCP/3306  |            |
+| postgres | TCP/5432  |            |
+| rabbitmq | HTTP/5672 |            |
+| grafana  | HTTP/3000 | monitoring |