From a6a33157091f02d55a0c62f33a9d036088d8867f Mon Sep 17 00:00:00 2001
From: Surabhi <surabhi.mahawar@aurigait.com>
Date: Tue, 12 Jul 2022 15:14:01 +0530
Subject: [PATCH] readme

---
 .github/workflows/build.yml             | 3 ++-
 .github/workflows/docker-build-push.yml | 4 ++--
 README.md                               | 5 +++++
 3 files changed, 9 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 928945d..23483e3 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,4 +1,5 @@
-name: Build on Push & Pull Request
+# Build on Push & Pull Request
+name: Maven Build
 on: 
   push:
     branches:
diff --git a/.github/workflows/docker-build-push.yml b/.github/workflows/docker-build-push.yml
index 5becbb7..91ce07a 100644
--- a/.github/workflows/docker-build-push.yml
+++ b/.github/workflows/docker-build-push.yml
@@ -1,5 +1,5 @@
-name: Docker Build & Push on Tag
-
+# Docker Build & Push on Tag
+name: Docker Build
 on:
   push:
     tags:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..faed262
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+![Maven Build](https://github.com/samagra-comms/orchestrator/actions/workflows/build.yml/badge.svg)
+![Docker Build](https://github.com/samagra-comms/orchestrator/actions/workflows/docker-build-push.yml/badge.svg)
+
+# 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.