From 87269e3b70aa9685b6c80ef2d9b1d98c3b4a4758 Mon Sep 17 00:00:00 2001
From: Chris Cromer <chris@cromer.cl>
Date: Fri, 22 Jul 2022 23:17:19 -0400
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d1c9b2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Alai Server
+
+This is the server which will host the Alai game binaries, backend API that receives game data, and maybe at some point a frontend for all of that.
+
+## Authors
+
+- Christohper Cromer
+- Martín Araneda Acuña
+
+## Backend API
+
+The backend is written in *go* and uses gorm to handle its database schema.
+
+## Game
+
+The directory game should contain the binaries for Alai which will be exposed through nginx for downloading.
+
+## Build and run
+
+```
+docker-compose up -d --build
+```
+
+## Stop the server
+
+```
+docker-compose down
+```
+
+## License
+The server is licensed under the [3-Clause BSD License](LICENSE).
\ No newline at end of file