From 1a5bde6577ffa20e821ce0a4546ff796cfadf812 Mon Sep 17 00:00:00 2001
From: Garett Sidwell <63107655+Garett601@users.noreply.github.com>
Date: Tue, 22 Oct 2024 07:08:56 +0200
Subject: [PATCH] docs(README.md): update readme file

Add instructions on CI additions and link to dataset used
---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 0dbfc95..5fb0a26 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,8 @@ uv lock
 ## 21/10/2024 - CI pipeline edits
 - added `uv pip install pre-commit` to the CI pipeline
 - added `uv run pre-commit run --all-files` to the CI pipeline
+- added `uv pip install pytest pytest-mock pytest-cov` to the CI pipeline
+- added `uv run pytest --cov=power_consumption tests/` to the CI pipeline
 
 - ```yaml
     name: CI
@@ -83,5 +85,14 @@ uv lock
             run: |
             uv pip install pre-commit
             uv run pre-commit run --all-files
+
+      - name: Run tests with coverage
+        run: |
+          uv pip install pytest pytest-mock pytest-cov
+          uv run pytest --cov=power_consumption tests/
   ```
+
+## Dataset
+- The dataset is not included in the repository to avoid large file size. It should first attempt to get the data from the UCI ML Repository.
+- If that fails, the dataset is expected to be in `data/Tetuan City power consumption.csv`. You can download it from [here](https://www.kaggle.com/datasets/gmkeshav/tetuan-city-power-consumption).
 ---