summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlejandro Cabrera <alejandro.cabrera@rackspace.com>2014-01-15 13:18:16 -0500
committerAlejandro Cabrera <alejandro.cabrera@rackspace.com>2014-01-15 13:18:16 -0500
commitf18df4ea275a0c586ff6fc68cbc9fbdfe7c66874 (patch)
treed24d181d3ee865b19f238268f3ac817c93427f18 /README.md
parent794b02811d8c6fdad304955a4602fb1324270f95 (diff)
downloadpython-memcached-f18df4ea275a0c586ff6fc68cbc9fbdfe7c66874.tar.gz
feat(tox): add support for testing with tox
This adds notes in the README and a tox.ini file for use with the tox test manager. This helps greatly towards migrating python-memcached towards python 3.3+ compatibility.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2f29ab7..4fee26a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+## Overview
+
This software is a 100% Python interface to the memcached memory cache
daemon. It is the client side software which allows storing values in one
or more, possibly remote, memcached servers. Search google for memcached
@@ -14,3 +16,14 @@ Please report issues and submit code changes to the github repository at:
For changes prior to 2013-03-26, see the old Launchpad repository at:
Historic issues: https://launchpad.net/python-memcached
+
+## Testing
+
+Test patches locally and easily by running tox:
+
+ pip install tox
+ tox -e py27
+
+Test for style by running tox:
+
+ tox -e pep8