From f64edc53e1652fd6c2496c1e61420f1d20da3d14 Mon Sep 17 00:00:00 2001
From: jmo <Mopsahl97@gmail.com>
Date: Thu, 19 May 2022 23:48:11 +0200
Subject: [PATCH] README

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c78ac018..5524a789 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-Her ligger vår api kode :)))))))))))
+### Platform for secure data management
+This is a platform hosted on NTNU Gjøviks SkyHiGh cloud. The platform consists of an API which students and researchers can use to create private secure network for their data. This data will not be available for download, however it can be interacted with on the Windows 10 workstations that are available. 
+
+### Running the API
+The API is ran in a docker container alongside other containers that its dependant on. To create these containers:
+- Download the service user key from https://skyhigh.iik.ntnu.no/ and place it in the /creds folder
+- source the file:
+```
+. ./creds/<file>
+```
+- Run the following command
+```
+cd orchestrationapi/docker/
+```
+- Run the following command
+```
+docker compose up -d
+```
+- Run the following command
+```
+cd logger/
+```
+- Run the following command
+```
+docker compose up -d
+```
+- The website will now be available on port 80, and the API is available on port 8080.
\ No newline at end of file
-- 
GitLab