From 5d911074ba86c7aefa9c1a39741ca8268a7c4d11 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Thu, 26 Feb 2015 11:28:01 -0500 Subject: Add inline example. Fixes #4 --- README | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README b/README index 6247cff..c249394 100644 --- a/README +++ b/README @@ -26,9 +26,24 @@ Usage Example ------- +The most simple usage looks like this in setup.py:: + + setup( + setup_requires=[ + 'pytest-runner', + ], + tests_require=[ + 'pytest', + ], + ) + +Additional dependencies require to run the tests (e.g. mock or pytest +plugins) may be added to tests_require and will be downloaded and +required by the session before invoking pytest. + See the `jaraco.collections `_ project -for example usage. +for real-world usage. Considerations -------------- -- cgit v1.2.1