README++

README.rst

@@ -1,24 +1,35 @@
 python-pure-cdb
 ===============
 
-.. image:: https://readthedocs.org/projects/python-pure-cdb/badge/?version=latest
-    :target: https://python-pure-cdb.readthedocs.io/en/latest/?badge=latest
+.. image:: https://github.com/bbayles/python-pure-cdb/actions/workflows/python-app.yml/badge.svg
+    :target: https://github.com/bbayles/python-pure-cdb/actions/workflows/python-app.yml
 
-The `python-pure-cdb` package (`pure-cdb <https://pypi.org/project/pure-cdb/>`_ on PyPI)
-is a Python library for working with D.J. Bernstein's "constant databases."
+**Full featured constant database reader, and writer**
 
-In addition to being able to read and write the database files produced by
-other `cdb` tools, this package can produce and consume "64-bit"
-constant databases that don't have the usual 4 GiB restriction.
+**Compatible with D.J. Bernstein's cdb**
 
-This package works with Python 3.4 and above.
-For a version that works with Python 2, see `this older release <https://github.com/dw/python-pure-cdb/releases/tag/v2.2.0>`_.
-To aid in porting `cdb` applications to Python 3, this library provides a
-compatability module for the `python-cdb <https://github.com/acg/python-cdb>`_
-package, which can act as a drop-in replacement (see `the docs <https://python-pure-cdb.readthedocs.io>`_).
+A constant database is a key-value database, a mapping, that can not
+be changed at runtime. That restriction allows to use a perfect hash
+that makes retrieval much faster than a regular, mutable, key-value store.
 
-For more information on constant databases, see `djb's page <https://cr.yp.to/cdb.html>`_
-and `Wikipedia <https://en.wikipedia.org/wiki/Cdb_(software)>`_.
+`pure-cdb` will read the files that are produced by the original tool
+written by D.J. Bernstein. It also support a 64-bit setting to avoid
+the restriction in the original design of 4-GiB database files.
+
+This package works with most common CPython versions, and PyPy.
+
+For a version that works with Python 2, see `this older release
+<https://github.com/dw/python-pure-cdb/releases/tag/v2.2.0>`_.  To aid
+in porting `cdb` applications to Python 3, this library provides a
+compatability module for the `python-cdb
+<https://github.com/acg/python-cdb>`_ package, which can act as a
+drop-in replacement (see `the docs
+<https://python-pure-cdb.readthedocs.io>`_).
+
+For more information on constant databases, see `djb's page
+<https://cr.yp.to/cdb.html>`_ and `Wikipedia
+<https://en.wikipedia.org/wiki/Cdb_(software)>`_.
 
 The documentation for this package is available at
-`https://python-pure-cdb.readthedocs.io <https://python-pure-cdb.readthedocs.io>`_.
+`https://python-pure-cdb.readthedocs.io
+<https://python-pure-cdb.readthedocs.io>`_.

setup.py

@@ -19,8 +19,7 @@
     author='David Wilson',
     author_email='[email protected]',
     description=description,
-    long_description=description,
-    long_description_content_type='text/x-rst',
+    long_description=open('README.rst').read(),
     download_url='https://github.com/dw/python-pure-cdb',
     keywords='cdb file format appengine database db',
     license='MIT',