From add7bde1e307b056d49e74403f2db639b18995fe Mon Sep 17 00:00:00 2001
From: OZGCloud <ozgcloud@mgm-tp.com>
Date: Thu, 7 Nov 2024 09:10:51 +0100
Subject: [PATCH] fill readme

---
 .gitignore | 43 +++++++++++++++++--------------------------
 README.md  | 23 ++++++++++++++++++++++-
 2 files changed, 39 insertions(+), 27 deletions(-)

diff --git a/.gitignore b/.gitignore
index 099f2fd..174f396 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,29 +1,20 @@
-# ---> Java
-# Compiled class file
-*.class
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**/target/
+!**/src/test/**/target/
 
-# Log file
-*.log
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
 
-# BlueJ files
-*.ctxt
+*.attach*
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-replay_pid*
-
-/token-checker-interface/target/
-/token-checker-server/target/
-/.idea/
+.idea
+*.iml
+*.orig
+.vscode/
diff --git a/README.md b/README.md
index 4f64cf4..482ef60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
-# token-checker
+# Token Checker
 
+Zentraler Dienst um (Saml-)Token auf Gültigkeit zu prüfen. Unterstützt werden aktuell folgende Tokens:
+
+* Mein Unternehmenskonto (MUK) SamlToken
+
+## Schnittstelle
+
+### Request
+    CheckToken
+      token: String
+      
+### Response
+	* tokenValid: boolean
+	* oneOf:
+		* tokenAttributes
+			* postkorbId: String
+			* trustLevel: String
+			* otherFields: Repeated:
+			    * name: String
+	    			* value: String
+	    	* checkError
+	    		* message: String
-- 
GitLab