Merge pull request #283 from secynic/278/docs

278/docs

ASN.rst

@@ -5,6 +5,25 @@ IP ASN Lookups
 This is new functionality as of v0.15.0. This functionality was migrated from
 net.Net and is still used by IPWhois.lookup*().
 
+.. note::
+
+    Cymru ASN data should not be considered a primary source for data points
+    like country code.
+
+    Message from the Cymru site::
+
+        The country code, registry, and allocation date are all based on data
+        obtained directly from the regional registries including: ARIN, RIPE,
+        AFRINIC, APNIC, LACNIC. The information returned relating to these
+        categories will only be as accurate as the data present in the RIR
+        databases.
+
+        IMPORTANT NOTE: Country codes are likely to vary significantly from
+        actual IP locations, and we must strongly advise that the IP to ASN
+        mapping tool not be used as an IP geolocation (GeoIP) service.
+
+    https://team-cymru.com/community-services/ip-asn-mapping/
+
 .. _ip-asn-input:
 
 IP ASN Input

CHANGES.rst

@@ -30,6 +30,7 @@ Changelog
 - Added ip_failed_total key to stats dictionary in
   experimental.bulk_lookup_rdap (#235)
 - Added ipv4_generate_random and ipv6_generate_random to utils CLI (#236)
+- Added documentation note for ASN data (#278)
 
 1.1.0 (2019-02-01)
 ------------------

README.rst

@@ -7,8 +7,10 @@ ipwhois
 .. image:: https://coveralls.io/repos/github/secynic/ipwhois/badge.svg?branch=
     master
     :target: https://coveralls.io/github/secynic/ipwhois?branch=master
+.. image:: https://img.shields.io/github/issues-raw/secynic/ipwhois
+    :target: https://github.com/secynic/ipwhois/issues
 .. image:: https://codeclimate.com/github/secynic/ipwhois/badges/issue_count.svg
-   :target: https://codeclimate.com/github/secynic/ipwhois
+    :target: https://codeclimate.com/github/secynic/ipwhois
 .. image:: https://img.shields.io/badge/license-BSD%202--Clause-blue.svg
     :target: https://github.com/secynic/ipwhois/tree/master/LICENSE.txt
 .. image:: https://img.shields.io/badge/python-2.7%2C%203.4+-blue.svg