diff --git a/docs/01-testing.rst b/docs/01-testing.rst new file mode 100644 index 0000000..f116eed --- /dev/null +++ b/docs/01-testing.rst @@ -0,0 +1,10 @@ +Running the test suite +====================== + +In order to run the test suite for ``django-daraja``, run the following command from the cli: + + .. code-block:: none + + $ python setup.py test + +You should see the tests complete without error!! \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4dea382..442fc44 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,9 +6,12 @@ Welcome to django-daraja's documentation! ========================================= +This is a django library that interacts with the MPESA Daraja API. + .. toctree:: :maxdepth: 2 - :caption: Contents: + + 01-testing