diff --git a/README.md b/README.md index 045e7eb..d522bc6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Asynchronous DB calculations reading the binary log +# MyCDC + +Application to run asynchronous operations based on DB changes. It is divided +into three services: + +- RabbitMQ: Service that allows the exchange and queuing of messages between +applications. +- Producer: Reads and filters changes from the DB binary log and adds the +relevant messages to each RabbitMQ queue. +- Consumer: Obtains the elements from the queues and performs the necessary +operations asynchronously. ## Enviroment setup @@ -13,8 +23,9 @@ git checkout fix-143 Apply *zongji.sql* script into DB. -Copy *config.json* to *config.local.json* and place your local configuration -there. +Copy *producer.json* and *consumer.json* from *config* directory to +*producer.local.json* and *consumer.local.json* and place your local +configuration there. Install dependencies. ```text