From 3d79e69b78b8fd22bacccc79c8cbb3450ef4424b Mon Sep 17 00:00:00 2001
From: Klaas Kliffen <kliffen@astron.nl>
Date: Mon, 19 Feb 2024 11:50:11 +0100
Subject: [PATCH] docs: update README

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 74edc30..8225347 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,19 @@
 # Ludwig Integration Test
 
-## Running integration test
+This repo contains the integration test for Ludwig.
+It is based on Selenium, which requires some additional packages to be available, therefore
+it is recommended to run the integration test inside of docker.
+It uses a docker bind volume to include the tests from the `tests` directory in the container.
+
+## Running the integration test
 
 ```bash
-docker compose run integration pytest
+export FE_VERSION=""    # container tag; defaults to latest
+export BE_VERSION=""    # container tag; defaults to latest
+docker compose run --rm integration pytest
 ```
+
+## Work in progress
+
+- Database migrations & data fixtures
+- Test isolation (wrt. data in the DB)
-- 
GitLab