added comments on readme file

Signed-off-by: Mohd Kaif Siddique <[email protected]>

sunbird-rc-esignet-integration-impl/README.md

@@ -51,24 +51,53 @@ mosip.esignet.vci.key-values={ 'credential_issuer': '${mosip.esignet.vci.identif
 
 ##---------------------------------Sunbird-RC Plugin Configurations------------------------------------------------------------##
 
+# Base url of registry system 
 mosip.esinet.sunbird-rc.base-url=http://localhost
+
+# These two are the default fields required to generate the dynamic authentication form
 mosip.esignet.authenticator.default.auth-factor.kba.field-details={{'id':'policyNumber', 'type':'text', 'format':''},{'id':'name', 'type':'text', 'format':''},{'id':'dob', 'type':'date', 'format':'dd/mm/yyyy'}}
 mosip.esignet.authenticator.default.auth-factor.kba.individual-id-field=policyNumber
 
-mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber
+# Mandatory fields required for KBA are described here 
 mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.field-details={{"id":"policyNumber", "type":"text", "format":""},{"id":"fullName", "type":"text", "format":""},{"id":"dob", "type":"date", "format":"dd/mm/yyyy"}}
-mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search
+# Amoung mandatory fields, which field is Indentity field is described here
+mosip.esignet.authenticator.sunbird-rc.auth-factor.kba.individual-id-field=policyNumber
+
+# This is the field which is used to get the entity id from the registry object
 mosip.esignet.authenticator.sunbird-rc.kba.entity-id-field=osid
 
+# This is the field is used to enable the registry search based on the PSUT
 mosip.esignet.vciplugin.sunbird-rc.enable-psut-based-registry-search=false
-mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=http://10.3.148.107/registry/api/v1/Insurance/search
+
+# Url for the verifiable credential issuance
 mosip.esignet.vciplugin.sunbird-rc.issue-credential-url=${mosip.esinet.sunbird-rc.base-url}/credential/credentials/issue
-mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential
+# Specifies the types of verifiable credentials supported by the system.
+# Based on the supported credentiels type the subsequent properties are defined 
+mosip.esignet.vciplugin.sunbird-rc.supported-credential-types=InsuranceCredential,ExampleVerifiableCredential
+
+# Properties for the Insurance Credential
+
+# Url for object based registry search
+mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-search-url=${mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/search
+# Here we define the verifiable credential issuer DID
 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322
+# Here we provide the template url for the credential
 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json
+# Url to get registry object based on the entity id
 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.registry-get-url={mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/
+# Here we define the schema id for the verfiable credential
 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba
+# Here we define the schema version for the verfiable credential
 mosip.esignet.vciplugin.sunbird-rc.credential-type.InsuranceCredential.cred-schema-version=1.0.0
+
+# Properies for the Mosip Verifiable Credential
+
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.registry-search-url=${mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/search
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.static-value-map.issuerId=did:web:holashchand.github.io:test_project:32b08ca7-9979-4f42-aacc-1d73f3ac5322
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.template-url=${spring_config_url_env}/*/${active_profile_env}/${spring_config_label_env}/insurance-credential.json
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.registry-get-url={mosip.esinet.sunbird-rc.base-url}/registry/api/v1/Insurance/# Here we define the schema id for the verfiable credential
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.cred-schema-id=did:schema:0d10a2cf-94de-4ffc-b32c-4f1a61ee05ba# Here we define the schema version for the verfiable credential
+mosip.esignet.vciplugin.sunbird-rc.credential-type.ExampleVerifiableCredential.cred-schema-version=1.0.0
 ````