From ac48e8f8f689fb161092e166fd89e72b2a590f24 Mon Sep 17 00:00:00 2001
From: binsky <timo@binsky.org>
Date: Wed, 26 Jan 2022 10:25:41 +0100
Subject: [PATCH] add build instructions, dependencies and contributors to
 readme

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fd63811..164d20a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# ciip-gruppe8-password-manager
+# ciip-grp8-password-manager
 
+## Dependencies
+- productive
+    - java 11
+- development
+    - java 11
+    - maven
+
+## Build jar file artifact
+- requires development dependencies
+
+`mvn package`
+
+## Run jar file artifact
+- requires productive dependencies
+- requires a built jar file to run
+
+`java -jar target/ciip-grp8-password-manager-1.0-SNAPSHOT.jar`
+
+## Contributors
+- binsky - Timo Triebensky
+- fdai6352 - Pascal Schubert
+- Claud11 - Claudia Metzler