From 92e948aabce79f0eb303d0e669b46a1230573f57 Mon Sep 17 00:00:00 2001
From: Paul Makles <me@insrt.uk>
Date: Sun, 9 Jun 2024 14:11:30 +0100
Subject: [PATCH] chore: update README [skip ci]

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index ee942fa7..71d8a4ed 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,21 @@ Tag and push a new release by running:
 just release
 ```
 
+## Testing
+
+First, start the required services:
+
+```sh
+docker compose -f docker-compose.db.yml up -d
+```
+
+Now run tests for whichever database:
+
+```sh
+TEST_DB=REFERENCE cargo nextest run
+TEST_DB=MONGOBD cargo nextest run
+```
+
 ## License
 
 The Revolt backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/backend/blob/master/LICENSE).