npm - geoip-lite2 - Versions diffs - 2.1.8 → 2.1.10 - Mend

@@ -1,8 +1,12 @@
 <div align="center">
-    <h1>🗺️ GeoIP-Lite2 v2.1 - Now even faster!</h1>
-    A native Node.js API for the GeoLite data from MaxMind.<br>
-    This product includes GeoLite data created by MaxMind, available from: https://www.maxmind.com
-    <br><br>
+    <a href="https://cdn.sefinek.net/images/npm/geoip-lite2/banner.jpg" target="_blank" title="Full screen">
+        <img src="https://cdn.sefinek.net/images/npm/geoip-lite2/banner.jpg" alt="GeoIP-Lite2 v2.1 🗺️ Now even faster!">
+    </a>
+    <br>
+    <p>
+        A native <a href="https://nodejs.org" target="_blank" title="Open nodejs.org">Node.js</a> API for the GeoLite data from MaxMind.<br>
+        This product includes GeoLite data created by MaxMind, available from: <a href="https://www.maxmind.com" target="_blank" title="Open www.maxmind.com">www.maxmind.com</a>
+    </p>
     <a href="https://www.npmjs.com/package/geoip-lite2" target="_blank" title="geoip-lite2 - npm" style="text-decoration:none">
         <img src="https://img.shields.io/npm/dt/geoip-lite2?maxAge=3600" alt="The number of downloads">
         <img src="https://img.shields.io/github/last-commit/sefinek24/geoip-lite2" alt="Last commit">
@@ -14,7 +18,7 @@
 🚀 Improved GeoIP Module by [Sefinek](https://sefinek.net)
-------------
+------------------------------------------
 This module is an improved and updated edition of [geoip-lite](https://github.com/geoip-lite/node-geoip), thoughtfully designed to meet the latest programming standards.
 All components have undergone meticulous updates to ensure peak performance and functionality.
@@ -27,15 +31,17 @@ This change enhances testing and contributes to the overall reliability of the m
 > I am not the creator of this npm module! All copyright rights belong to its original [Creators](AUTHORS).
 ✨ Demonstration
-------------
-You can see this module in action on my official API. Generally speaking, the API interface is public, and you can safely use it in your projects. Happy coding!
+----------------
+You can see this module in action on my [official API](https://sefinek.net). Generally speaking, the API interface is public, and you can safely use it in your projects. Happy coding!
-> Endpoint : https://api.sefinek.net/api/v2/geoip/{ip}
+> Endpoint : https://api.sefinek.net/api/v2/geoip/
 > Example  : https://api.sefinek.net/api/v2/geoip/109.207.159.255
 📑 Introduction
-------------
+---------------
 MaxMind provides a set of data files for IP to Geo mapping along with opensource libraries to parse and lookup these data files.
 One would typically write a wrapper around their C API to get access to this data in other languages (like JavaScript).
@@ -47,24 +53,24 @@ Both IPv4 and IPv6 addresses are supported, however since the GeoLite IPv6 datab
 information, city, region and postal code lookups are only supported for IPv4.
 > **Warning**
-> **You MUST update the data files after installation.** The MaxMind license does not allow us to distribute the latest version of the data files with this package. Follow the instructions under update the datafiles for details.
+> **You SHOULD update the data files after installation.** The MaxMind license does not allow us to distribute the latest version of the data files with this package. Follow the instructions under update the datafiles for details.
 📚 Philosophy
-----------
+-------------
 I was really aiming for a fast JavaScript native implementation for geomapping of IPs.
 My prime motivator was the fact that it was really hard to get libgeoip built for Mac OSX without using the library from MacPorts.
 🕵️‍♂️ Why GeoIP-Lite?
--------------
+------------------
 GeoIP-Lite is a fully JavaScript implementation of the MaxMind GeoIP API. It is not as fully featured as bindings that use `libgeoip`.
 By reducing scope, this package is about 40% faster at doing lookups. On average, an IP to Location lookup should take 20 microseconds on
 a Macbook Pro. IPv4 addresses take about 6 microseconds, while IPv6 addresses take about 30 microseconds.
 📝 Synopsis
---------
+------------
 ### Script
 ```javascript
 const geoIp2 = require('geoip-lite2');
@@ -92,7 +98,8 @@ console.log(geo);
 🛠️ Installation
-------------
+----------------
 ### 1. Get the library
 ```cmd
 npm install geoip-lite2
@@ -110,7 +117,7 @@ You can create maxmind account [here](https://www.maxmind.com/en/geolite2/signup
 🧩 API
----
+-------
 GeoIP-Lite2 is completely synchronous. There are no callbacks involved.
 All blocking file IO is done at startup time, so all runtime calls are executed in-memory and are fast.
 Startup may take up to 200ms while it reads into memory and indexes data files.
@@ -129,7 +136,7 @@ If the IP address was found, the `lookup` method returns an object with the foll
 ```javascript
 {
    range: [ <low bound of IP block>, <high bound of IP block> ],
-   country: 'XX',                 // 2 letter ISO-3166-1 country code
+   country: 'CC',                 // 2 letter ISO-3166-1 country code
    region: 'RR',                  // Up to 3 alphanumeric variable length characters as ISO 3166-2 code
                                   // For US states this is the 2 letter state
                                   // For the United Kingdom this could be ENG as a country like “England
@@ -161,7 +168,7 @@ input itself.
 🔄 Built-in Updater
-----------------
+--------------------
 This package contains an update script that can pull the files from MaxMind and handle the conversion from CSV.
 A npm script alias has been setup to make this process easy. Please keep in mind this requires internet and MaxMind
 rate limits that amount of downloads on their servers.
@@ -180,7 +187,7 @@ npm run updatedb-force license_key=YOUR_LICENSE_KEY
 ```
 You can also run it by doing:
-```bash
+```shell
 node ./node_modules/geoip-lite2/scripts/updatedb.js license_key=YOUR_LICENSE_KEY
 ```
@@ -211,7 +218,7 @@ This tool can be used with `npm run updatedb` to periodically update geo data on
 ⚠️ Caveats
--------
+-----------
 This package includes the GeoLite database from MaxMind. This database is not the most accurate database available,
 however it is the best available for free. You can use the commercial GeoIP database from MaxMind with better
 accuracy by buying a license from MaxMind, and then using the conversion utility to convert it to a format that
@@ -222,7 +229,7 @@ how busy your disk is at that time. It can take as little as 200ms on a lightly
 cost though, and you make it up at run time with very fast lookups.
 ### Memory usage
-Quick test on memory consumption shows that library uses around 100Mb per process.
+Quick test on memory consumption shows that library uses around 100 MB per process.
 ```javascript
 const geoIp2 = require('geoip-lite2');
@@ -242,23 +249,23 @@ console.log(process.memoryUsage());
 🔀 Alternatives
-----------
+---------------
 If your use-case requires doing less than 100 queries through the lifetime of your application or if you need really fast latency on start-up, you might want to look into [fast-geoip](https://github.com/onramper/fast-geoip) a package with a compatible API that is optimized for serverless environments and provides faster boot times and lower memory consumption at the expense of longer lookup times.
 🔖 References
-----------
-  - <a href="http://www.maxmind.com/app/iso3166">Documentation from MaxMind</a>
-  - <a href="http://en.wikipedia.org/wiki/ISO_3166">ISO 3166 (1 & 2) codes</a>
-  - <a href="http://en.wikipedia.org/wiki/List_of_FIPS_region_codes">FIPS region codes</a>
+-------------
+- [Documentation from MaxMind](https://www.maxmind.com/app/iso3166)
+- [ISO 3166 (1 & 2) codes](https://en.wikipedia.org/wiki/ISO_3166)
+- [FIPS region codes](https://en.wikipedia.org/wiki/List_of_FIPS_region_codes)
 ©️ Copyright
----------
-`GeoIP-Lite` is Copyright 2011-2018 Philip Tellis <philip@bluesmoon.info>
-`GeoIP-Lite2` is Copyright 2023 Sefinek <contact@sefinek.net> (https://sefinek.net)
+------------
+`GeoIP-Lite` is Copyright 2011-2018 **Philip Tellis** <philip@bluesmoon.info>
+`GeoIP-Lite2` is Copyright 2023 **Sefinek** <contact@sefinek.net> (https://sefinek.net)
 🔐 License
--------
-There are two licenses for the code and data. See the [LICENSE](LICENSE) file for details.
+----------
+There are two licenses for the code and data. See the [LICENSE](LICENSE) file for details.

@@ -1,6 +1,6 @@
 {
   "name": "geoip-lite2",
-  "version": "2.1.8",
+  "version": "2.1.10",
   "description": "A light weight native JavaScript implementation of GeoIP API from MaxMind.",
   "keywords": [
     "city",
@@ -62,9 +62,9 @@
     "async": "^3.2.4",
     "chalk": "4.1.2",
     "iconv-lite": "0.6.3",
-    "ip-address": "^8.1.0",
+    "ip-address": "^9.0.5",
     "lazy": "1.0.11",
-    "rimraf": "^5.0.1"
+    "rimraf": "^5.0.5"
   },
   "devDependencies": {
     "eslint": "^8.50.0",

	@@ -1 +1 @@
1	- ~~ef6b46b8a2d067b8d453f763f63c14180f086a095a0cdf82bb7378b79cc20479~~ GeoLite2-City-~~CSV_20230922~~.zip
1	+ 26de70dfbc16d299fbe08a7f61b939865a63c7a34eefb4b755236330daa96a9a GeoLite2-City-CSV_20230926.zip

	@@ -1 +1 @@
1	- ~~e5e56baea61630fa8d22f76ca804fd353024ac38364abd2a65c126be7e7fab8c~~ GeoLite2-Country-~~CSV_20230922~~.zip
1	+ 81a25a98517b6b65004457a70df9bfdd25a95ec923e120fb9ceb4b1ce80181b0 GeoLite2-Country-CSV_20230926.zip

	@@ -1 +1 @@
1	- const o=require('../lib/geoip.js').lookup('~~158~~.~~255~~.88.0');console.log(o);
1	+ const o=require('../lib/geoip.js').lookup('86.63.89.41');console.log(o);

geoip-lite2 2.1.8 → 2.1.10