From b40ef1ff1c733762ffddda71ed3429e0f0cf73f9 Mon Sep 17 00:00:00 2001
From: Tushar <30565750+tushar5526@users.noreply.github.com>
Date: Mon, 3 Apr 2023 01:15:26 +0530
Subject: [PATCH] Create README.md

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88fe3e3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# upsmf-registry
+
+There are 3 entities declared in the registry
+
+1. Students
+2. Teachers
+3. Institutes
+
+### Steps to Run 
+
+1. `docker-compose up -d`
+
+**NOTE**
+--------
+
+If you are not using the current config in the folder, then you would have to disable `password-on-login-required` and other settings default security settings in RC's keycloak for the `lr-service` to work properly.
+RC's keycloak is customised to force proper emails, username, mobile etc. but these details are missing from CASA database and data sanity is very less, therefor it is needed to disable all those configurations.
-- 
GitLab