FINANCE-141: README and LOCALSETUP for the egov custom consumer servi…

…ce (#23)

egov-custom-consumer/LOCALSETUP.md

@@ -0,0 +1,22 @@
+# Local Setup
+
+To setup the egov-custom-consumer service in your local system, clone the [Utilities repository](https://github.com/egovernments/utilities).
+
+## Dependencies
+
+### Infra Dependency
+
+- [ ] Postgres DB
+- [ ] Redis
+- [ ] Elasticsearch
+- [X] Kafka
+  - [X] Consumer
+  - [ ] Producer
+
+## Running Locally
+
+To run the egov-custom-consumer service locally, update below listed properties in `application.properties` before running the project:
+
+```ini
+egov.coexistence.hostname=#Host value of the co-existence finance erp server (ex: https://jalandhar-dev.egovernments.org)
+```

egov-custom-consumer/README.md

@@ -0,0 +1,33 @@
+# egov-custom-consumer service
+
+Custom consumer service invokes a co-existence api to clear the auth token present in co-existence finance erp if the user logs out in the rain maker system.
+
+### DB UML Diagram
+
+NA
+
+### Service Dependencies
+
+NA
+
+### Swagger API Contract
+
+NA
+
+## Service Details
+
+egov-custom-consumer is a consumer which listens to the res-custom-filter topic, and invokes co-existence rest end ponit to clear the auth token present in the co-existence finance erp.
+
+### API Details
+
+NA
+
+### Kafka Consumers
+
+egov.custom.async.filter.topic : res-custom-filter
+
+	listens to this topic to clear the auth token present in the finance co-existence erp.
+
+### Kafka Producers
+
+NA