search

ip2location / ip2location-nodejs

IP2Location Node.js Module - Knowing where your visitors from.
http://www.ip2location.com
MIT License
97 stars 29 forks source link

Documentation suggestions #5

Closed GeekStocks closed 6 years ago

GeekStocks commented 6 years ago

While implementing, I had a hard time because there is not a lot of documentation here. The points of difficulty were:

  1. IP2Location publishes an IPv4 and an IPv6 BIN file, but apparently you don't need both files to do both types. The naming of the files makes one think that if you have an IPv6 address you need to use IPv6 BIN, and vice versa for IPv4. But in fact the test.js in this projects 'src' folder shows both IPv4 and IPv6 formats being resolved by the IPv6 BIN, and I have confirmed with my own data that indeed the IPv6 BIN does both. So it is confusing why there are 2 files, and it would be good to explain the proper usage of the 2 BIN files.

  2. The library gives an error code 'IPv6 not supported' and it would be good to have an explanation of the error messages that this library gives off.

The BIN files are fast and this project has a lot going for it. Just needs documentation now.

ip2location-nodejs commented 6 years ago

We have added more information regarding the points you had mentioned. Hopefully things are clearer now.

GeekStocks commented 6 years ago

Much clearer - thanks!