Skip to content

Commit 888f141

Browse files
committed
docs: tweaks
1 parent df86f3c commit 888f141

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,28 @@
99

1010
> Identify if a response is an antibot challenge from CloudFlare, Akamai, DataDome, Vercel, and more.
1111
12+
## Supported Providers
13+
14+
### Anti-Bot Systems
15+
16+
- **CloudFlare** - Bot management and challenge pages
17+
- **Vercel** - Attack mode protection
18+
- **Akamai** - Bot Manager and Web Application Protector
19+
- **DataDome** - Bot protection with CAPTCHA challenges
20+
- **PerimeterX** - Behavioral bot detection
21+
- **Shape Security** - Enterprise bot management
22+
- **Kasada** - Advanced bot mitigation
23+
- **Imperva/Incapsula** - Web application firewall
24+
- **AWS WAF** - Amazon Web Services Web Application Firewall
25+
26+
### CAPTCHA Providers
27+
28+
- **reCAPTCHA** - Google's CAPTCHA service (v2 and v3)
29+
- **hCaptcha** - Privacy-focused CAPTCHA alternative
30+
- **FunCaptcha** - Arkose Labs interactive challenges
31+
- **GeeTest** - AI-powered CAPTCHA
32+
- **Cloudflare Turnstile** - Privacy-preserving CAPTCHA alternative
33+
1234
## Why
1335

1436
Websites receiving massive quantities of traffic throughout the day, like LinkedIn, Instagram, or YouTube, have sophisticated antibot systems to prevent automated access.
@@ -43,7 +65,7 @@ The library expects a [Fetch Response](https://developer.mozilla.org/en-US/docs/
4365
You can also pass optional `body` and `url` parameters for enhanced detection:
4466

4567
```js
46-
const result = isAntibot({
68+
const result = isAntibot({
4769
headers: response.headers,
4870
body: await response.text(),
4971
url: response.url
@@ -57,28 +79,6 @@ The library returns an object with the following properties:
5779
- `detected` (boolean): Whether an antibot challenge was detected
5880
- `provider` (string|null): The name of the detected provider (e.g., 'cloudflare', 'recaptcha')
5981

60-
## Supported Providers
61-
62-
### Anti-Bot Systems
63-
64-
- **CloudFlare** - Bot management and challenge pages
65-
- **Vercel** - Attack mode protection
66-
- **Akamai** - Bot Manager and Web Application Protector
67-
- **DataDome** - Bot protection with CAPTCHA challenges
68-
- **PerimeterX** - Behavioral bot detection
69-
- **Shape Security** - Enterprise bot management
70-
- **Kasada** - Advanced bot mitigation
71-
- **Imperva/Incapsula** - Web application firewall
72-
- **AWS WAF** - Amazon Web Services Web Application Firewall
73-
74-
### CAPTCHA Providers
75-
76-
- **reCAPTCHA** - Google's CAPTCHA service (v2 and v3)
77-
- **hCaptcha** - Privacy-focused CAPTCHA alternative
78-
- **FunCaptcha** - Arkose Labs interactive challenges
79-
- **GeeTest** - AI-powered CAPTCHA
80-
- **Cloudflare Turnstile** - Privacy-preserving CAPTCHA alternative
81-
8282
## License
8383

8484
**is-antibot** © [microlink.io](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/is-antibot/blob/master/LICENSE.md) License.<br>

0 commit comments

Comments
 (0)