Skip to content

Commit 45a2c0d

Browse files
committed
Updated docs in preparation for a release
1 parent 7f087ed commit 45a2c0d

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

HISTORY.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
History
44
-------
55

6+
0.2.0 (2013-10-15)
7+
++++++++++++++++++
8+
9+
* Refactored code and fixed a memory leak when throwing an exception.
10+
611
0.1.1 (2013-10-03)
712
++++++++++++++++++
813

README.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,8 @@ IPv6).
1717
Installation
1818
------------
1919

20-
First you must install the `libmaxminddb
21-
<https://github.com/maxmind/libmaxminddb>`_ C library. At the moment, you must
22-
use the `dave/major-refactor` branch. (If this branch does not exist when you
23-
read this, it was likely merged into master.)
20+
You must have the `libmaxminddb <https://github.com/maxmind/libmaxminddb>`_ C
21+
library installed before installing this extension.
2422

2523
To install the MaxMind DB extension, type:
2624

@@ -38,18 +36,18 @@ source directory:
3836
Usage
3937
-----
4038

41-
To use this module, you must first download or create a MaxMind DB file.
42-
We provide `free GeoLite2 databases
39+
To use this module, you must first download or create a MaxMind DB file. We
40+
provide `free GeoLite2 databases
4341
<http://dev.maxmind.com/geoip/geoip2/geolite2>`_. These files must be
4442
decompressed with ``gunzip``.
4543

46-
After you have obtained a database and importing the module, you must create
47-
a ``Reader`` object, providing the path to the file as the first argument to
48-
the constructor. After doing this, you may call the ``get`` method with an IP
44+
After you have obtained a database and importing the module, you must create a
45+
``Reader`` object, providing the path to the file as the first argument to the
46+
constructor. After doing this, you may call the ``get`` method with an IP
4947
address on the object. This method will return the corresponding values for
5048
the IP address from the database (e.g., a dictionary for GeoIP2/GeoLite2
51-
databases). If the database does not contain a record for that IP address,
52-
the method will return ``None``.
49+
databases). If the database does not contain a record for that IP address, the
50+
method will return ``None``.
5351

5452
Example
5553
-------
@@ -90,6 +88,6 @@ Support
9088
Please report all issues with this code using the `GitHub issue tracker
9189
<https://github.com/maxmind/MaxMind-DB-Reader-python/issues>`_
9290

93-
If you are having an issue with a MaxMind service that is not specific to
94-
this API, please contact `MaxMind support
95-
<http://www.maxmind.com/en/support>`_ for assistance.
91+
If you are having an issue with a MaxMind service that is not specific to this
92+
API, please contact `MaxMind support <http://www.maxmind.com/en/support>`_ for
93+
assistance.

0 commit comments

Comments
 (0)