Display architecture diagram in README - closes #1244

Author: fizyk

.pre-commit-config.yaml

@@ -16,6 +16,7 @@ repos:
       - id: trailing-whitespace
       - id: check-toml
       - id: end-of-file-fixer
+        exclude_types: [svg]
       - id: mixed-line-ending
       - id: check-yaml
       - id: pretty-format-json

README.rst

@@ -1,4 +1,4 @@
-.. image:: https://raw.githubusercontent.com/dbfixtures/pytest-postgresql/master/logo.png
+.. image:: https://raw.githubusercontent.com/dbfixtures/pytest-postgresql/main/logo.png
     :width: 100px
     :height: 100px
 
@@ -32,7 +32,7 @@ How to use
 
 .. warning::
 
-    Tested on PostgreSQL versions >= 10. See tests for more details.
+    Tested on PostgreSQL versions >= 14. See tests for more details.
 
 Install with:
 
@@ -44,6 +44,14 @@ You will also need to install ``psycopg``. See `its installation instructions <h
 Note that this plugin requires ``psycopg`` version 3. It is possible to simultaneously install version 3
 and version 2 for libraries that require the latter (see `those instructions <https://www.psycopg.org/docs/install.html>`_).
 
+How does it work
+----------------
+
+.. image:: https://raw.githubusercontent.com/dbfixtures/pytest-postgresql/main/docs/images/architecture.svg
+    :alt: Project Architecture Diagram
+    :align: center
+
+
 Plugin contains three fixtures:
 
 * **postgresql** - it's a client fixture that has functional scope.

newsfragments/1244.docs.rst

@@ -1 +1 @@
-Add plugins' architecture diagram.
+Add plugins' architecture diagram and display it in project's README.