Document pytest plugin usage

diff --git a/README.rst b/README.rst
index f97451d48991aa7676fd31b3b96e896a7577621a..7aba57faaddc28db3e01c1acf4978260366630a6 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -32,6 +32,39 @@ PGWUI_Testing stands for `PostgreSQL`_ Web User Interface regression testing.
 Utilities to assist in the testing and development of the PGWUI suite
 of programs.
 
+There are 2 sorts of libraries made available.  To enable the pytest
+plugin:
+
+  # Activiate the pytest plugin
+  pytest_plugins = ("pgwui",)
+
+This makes the following fixtures available:
+
+  pyramid_config
+    Input: None
+
+    Is a Pyramid auto-committing Configurator instance.
+
+  pyramid_request_config
+    Input: None
+
+    Is a Pyramid auto-committing Configurator instance.
+
+    Side Effects: pyramid.threadlocal.get_current_request() returns
+    a Pyramid DummyRequest instance.
+
+  pgwui__component_entry_point
+    Input: A pgwui component name, as a string
+
+    Returns: Boolean, does the supplied component have a PGWUI component
+    entry point?
+
+  pgwui_check_settings_entry_point
+    Input: A pgwui component name, as a string
+
+    Returns: Boolean, does the supplied component have a check_settings
+    entry point?
+
 
 Development Status
 ------------------