@@ -11,10 +11,10 @@ version: v2.6.0
1111
1212## Description ##
1313
14- This distribution provides an API for the GeoIP2
15- [ Precision web services] ( http://dev.maxmind.com/geoip/geoip2/web-services ) and
16- [ databases] ( http://dev.maxmind.com/geoip/geoip2/downloadable ) . The API also works with
17- the free [ GeoLite2 databases] ( http://dev.maxmind.com/geoip/geoip2/geolite2/ ) .
14+ This distribution provides an API for the GeoIP2
15+ [ Precision web services] ( http://dev.maxmind.com/geoip/geoip2/web-services ) and
16+ [ databases] ( http://dev.maxmind.com/geoip/geoip2/downloadable ) . The API also
17+ works with the free [ GeoLite2 databases] ( http://dev.maxmind.com/geoip/geoip2/geolite2/ ) .
1818
1919## Installation ##
2020
@@ -238,7 +238,7 @@ File database = new File("/path/to/GeoIP2-Anonymous-IP.mmdb");
238238
239239// This creates the DatabaseReader object, which should be reused across
240240// lookups.
241- DatabaseReader reader = new DatabaseReader .Builder (database). build()) ;
241+ DatabaseReader reader = new DatabaseReader .Builder (database). build();
242242
243243try {
244244 InetAddress ipAddress = InetAddress . getByName(" 85.25.43.84" );
@@ -333,6 +333,19 @@ Finally, if the web service returns a 200 but the body is invalid, the client
333333throws a ` GeoIp2Exception ` . This exception also is the parent exception to
334334the above exceptions.
335335
336+ ## Values to use for Database or Map Keys ##
337+
338+ ** We strongly discourage you from using a value from any ` getNames ` method as
339+ a key in a database or map.**
340+
341+ These names may change between releases. Instead we recommend using one of the
342+ following:
343+
344+ * ` com.maxmind.geoip2.record.City ` - ` City.getGeoNameId `
345+ * ` com.maxmind.geoip2.record.Continent ` - ` Continent.getCode ` or ` Continent.getGeoNameId `
346+ * ` com.maxmind.geoip2.record.Country ` and ` com.maxmind.geoip2.record.RepresentedCountry ` - ` Country.getIsoCode ` or ` Country.getGeoNameId `
347+ * ` com.maxmind.geoip2.record.Subdivision ` - ` Subdivision.getIsoCode ` or ` Subdivision.getGeoNameId `
348+
336349## Multi-Threaded Use ##
337350
338351This API fully supports use in multi-threaded applications. When using the
@@ -394,18 +407,16 @@ a correction, please [contact MaxMind support]
394407
395408## Other Support ##
396409
397- Please report all issues with this code using the [ GitHub issue tracker ]
398- (https://github.com/maxmind/GeoIP2-java/issues ).
410+ Please report all issues with this code using the
411+ [ GitHub issue tracker ] ( https://github.com/maxmind/GeoIP2-java/issues ) .
399412
400413If you are having an issue with a MaxMind service that is not specific
401- to the client API, please [ contact MaxMind support ]
402- (http://www.maxmind.com/en/support ).
414+ to the client API, please
415+ [ contact MaxMind support ] ( http://www.maxmind.com/en/support ) .
403416
404417## Requirements ##
405418
406- MaxMind has tested this API with Java 6 and above. Reasonable patches
407- for Java 5 will be accepted. Patches for 1.4 or earlier will not be
408- accepted.
419+ MaxMind has tested this API with Java 6 and above.
409420
410421## Contributing ##
411422
@@ -418,6 +429,6 @@ The GeoIP2 Java API uses [Semantic Versioning](http://semver.org/).
418429
419430## Copyright and License ##
420431
421- This software is Copyright (c) 2013 by MaxMind, Inc.
432+ This software is Copyright (c) 2013-2016 by MaxMind, Inc.
422433
423434This is free software, licensed under the Apache License, Version 2.0.
0 commit comments