Modifying gitignore and Readme

.gitignore

@@ -1,25 +1,15 @@
-# Compiled class file
-*.class
+.idea/
+*.ims
+*.iml
 
-# Log file
-*.log
+.classpath
+.project
+.factorypath
+.settings/
+.apt_generated/
 
-# BlueJ files
-*.ctxt
+target/
 
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-replay_pid*
-.idea
+bin/
+out/
+eclipse_plugin/lib/

README.md

@@ -1,2 +1,18 @@
 # sunbird-rc-keycloak
 Sunbird Variant of Keycloak
+
+### How to build from source
+* Run the following commands
+```bash 
+cd keycloak-mobile-number-login-spi
+./mvnw clean install
+mkdir -p ../keycloak/providers && cp target/keycloak-mobile-number-login-spi-1.0-SNAPSHOT.jar ../keycloak/providers
+```
+* This will build the Sunbird Keycloak plugin.
+* Once this is done, we will need to create the docker image and publish to our Docker repository
+```bash
+cd ../keycloak
+docker build -t <docker_image_path>:<docker_tag> .
+docker push <docker_image_path>:<docker_tag> 
+```
+