Skip to content

Commit

Permalink
Updated the table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-au-922 committed Dec 3, 2023
1 parent dbe4a10 commit e2d0f00
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Producer Consumer CI Test
on:
push:
branches: ["dev"]
branches: ["main", "dev"]
workflow_dispatch:
jobs:
load-dotenv:
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,25 @@
![Build Status](https://github.com/github/docs/actions/workflows/test.yml/badge.svg)
![Code Coverage](./coverage.svg)

## Table of contents

* [Producer Consumer CSV](#producer-consumer-csv)
* [Description](#description)
* [Architecture](#architecture)
* [Requirements](#requirements)
* [Database Schema](#database-schema)
* [records](#records)
* [Database Indexes](#database-indexes)
* [Queue](#queue)
* [Test Data](#test-data)
* [Installation](#installation)
* [Usage](#usage)
* [Postgres in Docker](#postgres-in-docker)
* [Running the application](#running-the-application)
* [End to end test](#end-to-end-test)
* [Unit tests](#unit-tests)
* [Code coverage report](#code-coverage-report)

## 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.

Expand Down Expand Up @@ -213,3 +232,6 @@ $ make test
```

The unit test will run the both the producer and consumer unit tests. The coverage report will be generated in the `.coverage` file.

### Code coverage report
You can generate the code coverage report by visiting the following link: https://alex-au-922.github.io/producer_consumer_csv/

0 comments on commit e2d0f00

Please sign in to comment.