Add diagrams for design illustration (#34)

Author: jbasko

README.rst

@@ -16,6 +16,8 @@ The plugin allows user to control the level of randomness they want to introduce
 reordering on subsets of tests. Tests can be rerun in a specific order by passing a seed value reported
 in a previous test run.
 
+.. image:: ./docs/pytest-random-order-design.png
+
 -----------
 Quick Start
 -----------
@@ -85,8 +87,16 @@ that causes problems you can look up the value in the test report and repeat the
 Design
 ------
 
+.. image:: ./docs/pytest-random-order-design.png
+
 The plugin groups tests in buckets, shuffles them within buckets and then shuffles the buckets.
 
+Given the test suite above, here are two of a few possible generated orders of tests:
+
+.. image:: ./docs/pytest-random-order-example1.png
+
+.. image:: ./docs/pytest-random-order-example2.png
+
 You can choose from a few types of buckets:
 
 class
@@ -116,6 +126,7 @@ global
 none
     Disable shuffling.
 
+
 If you have three buckets of tests ``A``, ``B``, and ``C`` with three tests ``1`` and ``2``, and ``3`` in each of them,
 then one of many potential orderings that non-global randomisation can produce could be:
 
@@ -244,3 +255,16 @@ v0.8.0
 ++++++
 
 * pytest cache plugin's ``--failed-first`` works now.
+
+-------
+Credits
+-------
+
+* The shuffle icon in the diagram is by artist `Daniele De Santis`_ and it was found on
+  `iconarchive`_.
+
+* The diagram is drawn with `sketchboard.io`_
+
+.. _Daniele De Santis: https://www.danieledesantis.net/
+.. _iconarchive: http://www.iconarchive.com/artist/danieledesantis.html
+.. _sketchboard.io: https://sketchboard.io/

docs/pytest-random-order-design.png

@@ -14,7 +14,7 @@ def read(fname):
 
 setup(
     name='pytest-random-order',
-    version='1.0.0',
+    version='1.0.1',
     author='Jazeps Basko',
     author_email='[email protected]',
     maintainer='Jazeps Basko',