Skip to content

Commit 12c8e7e

Browse files
committed
Update readme for module changes
1 parent 2ec26fb commit 12c8e7e

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
===========================
2-
MaxMind DB Python Extension
3-
===========================
1+
========================
2+
MaxMind DB Python Module
3+
========================
44

55
Beta Note
66
---------
@@ -10,17 +10,21 @@ release.
1010
Description
1111
-----------
1212

13-
This is a Python extension for reading MaxMind DB files. MaxMind DB is a
14-
binary file format that stores data indexed by IP address subnets (IPv4 or
15-
IPv6).
13+
This is a Python module for reading MaxMind DB files. The module includes both
14+
a pure Python reader and an optional C extension.
15+
16+
MaxMind DB is a binary file format that stores data indexed by IP address
17+
subnets (IPv4 or IPv6).
1618

1719
Installation
1820
------------
1921

20-
You must have the `libmaxminddb <https://github.com/maxmind/libmaxminddb>`_ C
21-
library installed before installing this extension.
22+
If you want to use the C extension, you must first install `libmaxminddb
23+
<https://github.com/maxmind/libmaxminddb>`_ C library installed before
24+
installing this extension. If the library is not available, the module will
25+
fall-back to a pure Python implementation.
2226

23-
To install the MaxMind DB extension, type:
27+
To install maxminddb, type:
2428

2529
.. code-block:: bash
2630
@@ -74,13 +78,16 @@ invalid IP address or an IPv6 address in an IPv4 database.
7478
Requirements
7579
------------
7680

77-
This code requires CPython 2.6+ or 3.3+. Older versions are not supported.
81+
This code requires Python 2.6+ or 3.3+. The C extension requires CPython. The
82+
pure Python implementation has been tested with PyPy.
83+
84+
On Python 2, the `ipaddr module <https://code.google.com/p/ipaddr-py/>`_ is
85+
required.
7886

7987
Versioning
8088
----------
8189

82-
The MaxMind DB Python extension uses
83-
`Semantic Versioning <http://semver.org/>`_.
90+
The MaxMind DB Python module uses `Semantic Versioning <http://semver.org/>`_.
8491

8592
Support
8693
-------

0 commit comments

Comments
 (0)