From 85f8eadc4e247a37aa09c719317ab6765c9c28b4 Mon Sep 17 00:00:00 2001
From: Paul Makles <paulmakles@gmail.com>
Date: Sun, 23 Oct 2022 16:09:00 +0100
Subject: [PATCH] chore: add notes for coverage tests

---
 .gitignore | 3 ++-
 README.md  | 7 +++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index 1de5659..35bbef9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
-target
\ No newline at end of file
+target
+tarpaulin-report.html
\ No newline at end of file
diff --git a/README.md b/README.md
index 7d65741..d94bcba 100644
--- a/README.md
+++ b/README.md
@@ -107,6 +107,13 @@ cargo test --features test
 cargo nextest run --features test
 ```
 
+Run a coverage test:
+
+```bash
+# Run tarpaulin
+cargo tarpaulin --features test --out html
+```
+
 ## Database Migrations
 
 Migrating the database is easy, you just have to orchestrate it yourself, ideally you have your own versioned migration system which you can slot changes into.