From f297742d25af2bbeb732b09c5a9d0f53afbbaf2f Mon Sep 17 00:00:00 2001
From: alex <alex@alexloehr.net>
Date: Mon, 26 May 2025 14:01:37 +0000
Subject: [PATCH] added readme

---
 README.md |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
index aa3e813..ec6a711 100644
--- a/README.md
+++ b/README.md
@@ -29,3 +29,25 @@
 Apache muss als Proxy für globus-ilias-rest fungieren und Verbindungen an diesen weiterreichen.
 
 todo
+
+
+
+## Usage
+
+Es wird ein Auth-Token gebraucht um den Service zu benutzen. Dieses wird in settings.js definiert.
+
+Dann kann der Service angesprochen werden (test mit curl):
+
+    curl localhost:4101/users?token=AUTHTOKEN
+
+
+### Routes
+
+Verfügbare Routen sind:
+
+    GET /users
+    GET /users/count
+    GET /user/login/:login
+    GET /user/userId/:userId
+
+

--
Gitblit v1.8.0