Skip to content

Commit 972eed7

Browse files
committed
Add a note about MaxMindBinaryProvider
Refs #301
1 parent 1b7c6aa commit 972eed7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,16 @@ A valid `City/ISP/Org` or `Omni` service's api key is required.
250250
This provider provides two constants `CITY_EXTENDED_SERVICE` by default and `OMNI_SERVICE`.
251251

252252

253+
### MaxMindBinaryProvider ###
254+
255+
The `MaxMindBinaryProvider` named `maxmind_binary` is able to geocode **IPv4 and IPv6 addresses**
256+
only. It requires a data file, and the [geoip/geoip](https://packagist.org/packages/geoip/geoip)
257+
package must be installed.
258+
259+
It is worth mentioning that this provider has **serious performance issues**, and should **not**
260+
be used in production. For more information, please read [issue #301](https://github.com/geocoder-php/Geocoder/issues/301).
261+
262+
253263
### GeonamesProvider ###
254264

255265
The `GeonamesProvider` named `geonames` is able to geocode and reverse geocode **places**.

0 commit comments

Comments
 (0)