Skip to content

Commit

Permalink
Updated the table of content
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-au-922 committed Dec 3, 2023
1 parent e2d0f00 commit 6f28c55
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

* [Producer Consumer CSV](#producer-consumer-csv)
* [Description](#description)
* [Todos](#todos)
* [Architecture](#architecture)
* [Requirements](#requirements)
* [Database Schema](#database-schema)
Expand All @@ -25,6 +26,15 @@
## Description
This is a simple producer consumer application that reads a csv file and writes the data to a database. The application is written in Python.

## Todos
- [x] Add CI pipeline
- [x] Add unit tests
- [x] Add code coverage report
- [x] Add end to end test
- [x] Add documentation
- [ ] Stablize the RabbitMQ connection
- [ ] Different indexing strategy for performance

## Architecture
The application is composed of the following components:
- Producer (Reads the csv file and sends the data to the message queue)
Expand Down

0 comments on commit 6f28c55

Please sign in to comment.