Merge pull request #5 from jelmer/long-description

Add long description

README.md

@@ -8,6 +8,16 @@ The package includes both a pure-Python version and an optional C extension
 based on Cython.  Both provide the same functionality, but the C extension
 provides significantly better performance.
 
+Example:
+
+```
+>>> from fastbencode import bencode, bdecode
+>>> bencode([1, 2, b'a', {b'd': 3}])
+b'li1ei2e1:ad1:di3eee'
+>>> bdecode(bencode([1, 2, b'a', {b'd': 3}]))
+[1, 2, b'a', {b'd': 3}]
+```
+
 License
 =======
 fastbencode is available under the GNU GPL, version 2 or later.

setup.py

@@ -122,11 +122,15 @@ def add_cython_extension(module_name, libraries=None, extra_source=[]):
 
 add_cython_extension('fastbencode._bencode_pyx')
 
+with open('README.md', 'r') as f:
+    long_description = f.read()
+
 
 setup(
     name="fastbencode",
     description="Implementation of bencode with optional fast C extensions",
     version="0.0.10",
+    long_description=long_description,
     maintainer="Breezy Developers",
     maintainer_email="[email protected]",
     url="https://github.com/breezy-team/fastbencode",