improve readme and fix travis

Author: samuelcolvin

.travis.yml

@@ -6,6 +6,7 @@ services:
 - postgresql
 
 python:
+- '3.5'
 - '3.6'
 - 'nightly'  # currently 3.7
 
@@ -25,7 +26,6 @@ addons:
     - ubuntu-toolchain-r-test
     packages:
     - gcc-5
-    - patchelf
 
 install:
 - sudo unlink /usr/bin/gcc && sudo ln -s /usr/bin/gcc-5 /usr/bin/gcc
@@ -38,7 +38,8 @@ script:
 - make lint
 - make test
 - ./tests/check_tag.py
-#- docker run --rm -v `pwd`:/io $DOCKER_IMAGE /io/tests/build-wheels.sh TODO currently broken as gcc-5 isn't available on centos 5
+# TODO manylinux is currently broken as gcc-5 isn't available on centos 5
+#- docker run --rm -v `pwd`:/io $DOCKER_IMAGE /io/tests/build-wheels.sh
 
 after_success:
 - ls -lha

README.rst

@@ -8,17 +8,24 @@ Fast delta encoding in python using xdelta3.
 Requirements
 ------------
 
-* **Python 3.6**
-* **linux**
+* **Python 3.5 or 3.6** - it's 2017: you should be using python 3.6 by now anyway.
+* **linux** - compilation only tested on ubuntu, might work on other platform.
+
+Installation
+------------
+
+.. code:: shell
+
+    pip install xdelta3
 
 Usage
 -----
 
 .. code:: python
 
     import xdelta3
-    value_one = b'this is a wonderful string to demonstrate with. Much of the two strings is duplicated.'
-    value_two = b'this is a different string to demonstrate with. Much of the two strings is duplicated.'
+    value_one = b'wonderful string to demonstrate xdelta3, much of these two strings is the same.'
+    value_two = b'different string to demonstrate xdelta3, much of these two strings is the same.'
     delta = xdelta3.encode(value_one, value_two)
 
     print(f'New string length: {len(value_two)}, delta length: {len(delta)}')

setup.cfg

@@ -8,7 +8,7 @@ max-line-length = 120
 max-complexity = 10
 
 [bdist_wheel]
-python-tag = py36
+python-tag = py35-py36
 
 [coverage:run]
 source = xdelta3

tests/test_main.py

@@ -21,3 +21,12 @@ def test_no_delta():
     with pytest.raises(xdelta3.NoDeltaFound) as exc_info:
         xdelta3.encode(b'hello', b'goodbye')
     assert exc_info.value.args[0] == 'No delta found shorter than the input value'
+
+
+def test_readme():
+    value_one = b'wonderful string to demonstrate xdelta3, much of these two strings is the same.'
+    value_two = b'different string to demonstrate xdelta3, much of these two strings is the same.'
+    delta = xdelta3.encode(value_one, value_two)
+
+    value_two_rebuilt = xdelta3.decode(value_one, delta)
+    assert value_two_rebuilt == value_two