From 767051f1ad21cc147cd0ad264c1b981a1665317c Mon Sep 17 00:00:00 2001
From: modzeleg <g.modzelewski@protonmail.com>
Date: Thu, 6 May 2021 17:02:15 +0200
Subject: [PATCH] T285 added readme file

---
 readme.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5d368c7
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,41 @@
+#XML Tools
+Content of this project is a service hosting tools for xml documents including xslt transformer,
+xpath selector and xsd validator.
+
+##About project
+Service is split into two microservices one containing JavaSpark web application and second hosting
+static documents.
+
+##JavaSpark backend
+Backend is hosted by default on port 8081. Rest api documentation is contained in OpenApi document
+openapi.yml
+
+Rest API accepts xml documents, given querry and processor version to call requested xml engine to perform given
+operation and finally returns outcome in response body.
+
+##Frontend
+All the static files are available by default on port 8086 and are located within folder.
+
+To preview given document user is required to post GET request to following path:
+```aidl
+/Frontend/{document name}
+```
+Documents are hosted by docker container running on ngix image and to modify container content
+one must modify Dockerfile located in Frontend folder. Files published must be located in ngix directory
+within created container.
+
+##How to run
+
+###Localy
+In order to run application use
+```aidl
+docker-compose up --build -d
+```
+Which will launch service on localhost.
+
+###Remote
+To launch service on remote host, exchange ssh keys with destination server and declare docker context ex. DEV.
+Then use following command
+```aidl
+docker-compose up --context DEV --build -d 
+```