From 5046927158ee5358c539ec4d085477c29a47f241 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jelmer=20Vernoo=C4=B3?= <jelmer@jelmer.uk>
Date: Wed, 7 Sep 2022 14:25:58 +0100
Subject: [PATCH] Add long description.

---
 README.md | 10 ++++++++++
 setup.py  |  4 ++++
 2 files changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b113c2e..82c0180 100644
--- a/README.md
+++ b/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.
diff --git a/setup.py b/setup.py
index 5533994..4c34190 100755
--- a/setup.py
+++ b/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="breezy-core@googlegroups.com",
     url="https://github.com/breezy-team/fastbencode",