From 7a4ea4c1ae92075165d1c2960da207236acc93cf Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Sun, 6 Dec 2020 20:59:00 +0100
Subject: [PATCH] README: document integration tests

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

diff --git a/README.rst b/README.rst
index 6a25248d..7bdd7412 100644
--- a/README.rst
+++ b/README.rst
@@ -31,6 +31,21 @@ To run the test suite for Slixmpp::
 
     python run_tests.py
 
+Integration tests require the following environment variables to be set:::
+
+    $CI_ACCOUNT1
+    $CI_ACCOUNT1_PASSWORD
+    $CI_ACCOUNT2
+    $CI_ACCOUNT2_PASSWORD
+    $CI_MUC_SERVER
+
+where the account variables are JIDs of valid, existing accounts, and
+the passwords are the account passwords. The MUC server must allow room
+creation from those JIDs.
+
+To run the integration test suite for Slixmpp::
+
+    python run_integration_tests.py
 
 The Slixmpp Boilerplate
 -------------------------