From 0275cb1d8e57c51ef23e22f5d4a1186f96e8ae8a Mon Sep 17 00:00:00 2001
From: Surabhi <surabhi.mahawar@aurigait.com>
Date: Tue, 2 Aug 2022 12:31:57 +0530
Subject: [PATCH] Read me update

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index faed262..d95eb7b 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,23 @@
 
 # Overview
 Orchestrator authenticates & processes the user data from whom the message is received. The XMessage will then be pushed to the kafka topic, the transformer will listen to this topic to further process it.
+
+# Getting Started
+
+## Prerequisites
+
+* java 11 or above
+* docker
+* kafka
+* postgresql
+* redis
+* fusion auth
+* lombok plugin for IDE
+* maven
+
+## Build
+* build with tests run using command **mvn clean install -U**
+* or build without tests run using command **mvn clean install -DskipTests**
+
+# Detailed Documentation
+[Click here](https://uci.sunbird.org/use/developer/uci-basics)
\ No newline at end of file