From 635ce66d6b0aa74acc1abaeebbac06c9531feec9 Mon Sep 17 00:00:00 2001 From: josephrocca <1167575+josephrocca@users.noreply.github.com> Date: Fri, 8 Dec 2023 19:13:32 +0800 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d49f05c..06054e4 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ This repo holds a daily-updated VPN/datacenter/bot IP list for a binary, simple, If you're looking for more than just a binary is/isn't, or want to know specifically whether it's a VPN vs bot vs datacenter, then this is not the repo for you. Please do not submit feature requests unless it's about a new, good data source. I'm keeping this repo very simple. -Example usage: +## Example usage: ```js import { isVpn } from "https://cdn.jsdelivr.net/gh/josephrocca/is-vpn@v0.0.1/mod.js"; let ip = "123.123.123.123"; if(isVpn(ip)) { - // do something (and remember, it could be a false positive!) + // do something (but remember, it could be an inaccurate classification) } ``` I will *never* change the location/format of `vpn-or-datacenter-ipv4-ranges.txt`, so you're welcome to use that file as part of an equivalent `isVpn` function for non-JS languages.