diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
new file mode 100644
index 0000000..0d23465
--- /dev/null
+++ b/.github/workflows/test.yaml
@@ -0,0 +1,20 @@
+name: Test
+
+on:
+ push:
+
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ version: [14, 16, 18, 20, 22, "latest"]
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v4
+ with:
+ node-version: ${{ matrix.version }}
+ - run: npm ci
+ - run: npm test
+ env:
+ IPINFO_TOKEN: ${{ secrets.IPINFO_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c23515b..d405b72 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,13 @@
# CHANGELOG
+## 4.0.0
+
+Version 4 is a major version bump due to changing internals
+(from http(s) to node-fetch) which consumers may depend on.
+
+- Replace NodeJS http(s) with [node-fetch](https://www.npmjs.com/package/node-fetch) for communication with API
+- Increases minimum Node engine version to 14
+
## 3.5.4 / 3.5.5
- Reject on timeout in lookupIP, lookupASN, and getMap
diff --git a/README.md b/README.md
index 0c03964..65ab697 100644
--- a/README.md
+++ b/README.md
@@ -33,70 +33,96 @@ yarn add node-ipinfo
### Usage
-##### TypeScript
+1. Initialize an instance of `IPinfoWrapper` with [your token](https://ipinfo.io/account/token).
```typescript
-import IPinfoWrapper, { IPinfo, AsnResponse } from "node-ipinfo";
+const { IPinfoWrapper } = require("node-ipinfo");
const ipinfoWrapper = new IPinfoWrapper("MY_TOKEN");
+```
-ipinfoWrapper.lookupIp("1.1.1.1").then((response: IPinfo) => {
- console.log(response);
-});
+> [!TIP]
+> If you are using ESM instead of CommonJS you can use `import`.
+> ```
+> import { IPinfoWrapper } from "node-ipinfo";
+> ```
-ipinfoWrapper.lookupASN("AS7922").then((response: AsnResponse) => {
- console.log(response);
-});
+2. Perform a lookup for an IP address or ASN.
+
+```typescript
+const ipinfo = await ipinfoWrapper.lookupIp("1.1.1.1");
```
-##### JavaScript
+Standalone example
+
+1. Create `ipinfo.js` with the following code, then replace `MY_TOKEN` with
+[your token](https://ipinfo.io/account/token).
-```javascript
+```typescript
const { IPinfoWrapper } = require("node-ipinfo");
-const ipinfo = new IPinfoWrapper("MY_TOKEN");
+const ipinfoWrapper = new IPinfoWrapper("MY_TOKEN");
-ipinfo.lookupIp("1.1.1.1").then((response) => {
- console.log(response);
-});
+const ipAddress = process.argv[2] || "1.1.1.1";
-ipinfo.lookupASN("AS7922").then((response) => {
- console.log(response);
-});
+ipinfoWrapper.lookupIp(ipAddress).then((ipinfo) => console.log(ipinfo));
```
-### Caching
+2. Run `ipinfo.js` (without an IP) to lookup 1.1.1.1.
-This library uses an LRU cache (deletes the least-recently-used items).
+```shell
+node ipinfo.js
+{
+ ip: '1.1.1.1',
+ // ...
+```
-If you prefer a different caching methodology, you may use the `IPCache` interface through TypeScript and implement your own caching system around your own infrastructure.
+3. Run `ipinfo.js` with an IP to lookup, like `2.2.2.2` `8.8.8.8` or
+[your IP](https://ipinfo.io/what-is-my-ip).
-The default cache length is 1 day and the default max number of items allowed in the cache is 5000. This can be changed by passing an `Option` to the `LruCache` constructor.
+```shell
+node ipinfo.js 2.2.2.2
+{
+ ip: '2.2.2.2',
+ // ...
+```
-##### TypeScript
+