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