From 11681fea458de1761e808684f578e183bddc40ef Mon Sep 17 00:00:00 2001
From: Ryan Collingham <ryan@tokencard.io>
Date: Tue, 17 Aug 2021 22:47:33 +0100
Subject: [PATCH] add note to README about pytest.ini

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

diff --git a/README.md b/README.md
index b35e920..d022d28 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,19 @@ pip install .
 pytest_commander /path/to/your/tests
 ```
 
+PyTest Configuration
+====================
+
+Configuration for PyTest such as extra command-line arguments may be specified
+by adding a pytest.ini file in the same directory. See
+https://docs.pytest.org/en/latest/reference/customize.html#pytest-ini for more
+details.
+
+Note that there is a known issue when using pytest_commander along with the
+xdist plugin, used to parallelise tests among multiple processes. You will
+have to remove xdist config options from your pytest.ini in order to use
+pytest-commander.
+
 Renaming
 ========