From 8945430f27a8c6fd632dd35382cb094abe3543ff Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kier=C3=A1n=20Meinhardt?= <kmein@posteo.de>
Date: Wed, 1 Dec 2021 09:42:11 +0100
Subject: [PATCH] feat(onomastics): add documentation route to server

---
 onomastics/geogen/server.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/onomastics/geogen/server.py b/onomastics/geogen/server.py
index 5750ec7..49d0f0c 100644
--- a/onomastics/geogen/server.py
+++ b/onomastics/geogen/server.py
@@ -4,6 +4,18 @@ import geogen.client
 app = Flask(__name__)
 
 
+@app.route("/")
+def help():
+    return """Welcome to Kierán's surname cartographer!
+
+The following routes are available to you:
+
+- /NAME/absolute.svg    displays a map of the absolute distribution of a surname
+- /NAME/relative.svg    displays a map of the relative distribution of a surname (divided by population of a landkreis)
+- /NAME/data.csv        returns the raw data, grouped by Landkreis
+    """
+
+
 @app.route("/<name>/relative.svg")
 def relative(name):
     color = request.args.get("color") or "navy"