Skip to content

Commit f25d194

Browse files
committed
Improve docs
1 parent 824fd2e commit f25d194

File tree

5 files changed

+28
-6
lines changed

5 files changed

+28
-6
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,18 @@ Cap is the modern open-source ReCAPTCHA alternative designed for speed. FOSS, li
3131
- **Easy to integrate**:
3232
Cap's web component & server-side library are super easy to integrate into your website
3333

34-
## Why Cap over Cloudflare Turnstile and other CAPTCHAS?
34+
# Why Cap over Cloudflare Turnstile and other CAPTCHAS?
3535

3636
* **Why use this over Turnstile:** Cloudflare Turnstile is known for having an extremely high error rate, especially for users using private browsers such as Brave or Librewolf. Also, Cap is open-source.
3737

3838
* **Why use this over RECAPTCHA:** Cap is significantly smaller and faster than RECAPTCHA, open-source, fully free and doesn't require you checking traffic signs due to its PoW nature.
3939

4040
* **Why use this over hCAPTCHA:** Not only is Cap's bundle 250x smaller than hCAPTCHA, it's open-source and doesn't require you checking traffic signs
4141

42-
* **Why use this over Altcha:** Cap is slightly smaller than altcha and easier to integrate, but if you don't care about that and want a more mature solution I would highly recommend checking it out.
42+
* **Why use this over Altcha:** Cap is slightly smaller than altcha and easier to integrate, but if you don't care about that and want a more mature solution I would highly recommend checking it out.
43+
44+
* **Why use this over FriendlyCaptcha:** Unlike FriendlyCaptcha, Cap is free & open-source (FriendlyCaptcha is €39/month for 5,000 requests and 5 domains) and has a smaller footprint.
45+
46+
* **Why use this over MTCaptcha:** Cap is more lightweight, doesn't rely on users solving an image puzzle that AIs like GPT-4o can solve, is open-source, more private and doesn't depend on third-party servers for verification.
47+
48+
* **Why use this over GeeTest:** Cap doesn't require an account or API keys, has no usage limits, and is completely open-source with a simpler integration process. It also doesn't rely on slow, complex image-based puzzles that frustrate users

docs/.vitepress/config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ export default defineConfig({
3030
sidebar: [
3131
{ text: "Quickstart", link: "/guide/index.md" },
3232
{ text: "Effectiveness", link: "/guide/effectiveness.md" },
33+
{ text: "Alternatives", link: "/guide/alternatives.md" },
3334
{ text: "Floating mode", link: "/guide/floating.md" },
3435
{ text: "Invisible mode", link: "/guide/invisible.md" },
3536
{

docs/guide/alternatives.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Why Cap over Cloudflare Turnstile and other CAPTCHAS?
2+
3+
* **Why use this over Turnstile:** Cloudflare Turnstile is known for having an extremely high error rate, especially for users using private browsers such as Brave or Librewolf. Also, Cap is open-source.
4+
5+
* **Why use this over RECAPTCHA:** Cap is significantly smaller and faster than RECAPTCHA, open-source, fully free and doesn't require you checking traffic signs due to its PoW nature.
6+
7+
* **Why use this over hCAPTCHA:** Not only is Cap's bundle 250x smaller than hCAPTCHA, it's open-source and doesn't require you checking traffic signs
8+
9+
* **Why use this over Altcha:** Cap is slightly smaller than altcha and easier to integrate, but if you don't care about that and want a more mature solution I would highly recommend checking it out.
10+
11+
* **Why use this over FriendlyCaptcha:** Unlike FriendlyCaptcha, Cap is free & open-source (FriendlyCaptcha is €39/month for 5,000 requests and 5 domains) and has a smaller footprint.
12+
13+
* **Why use this over MTCaptcha:** Cap is more lightweight, doesn't rely on users solving an image puzzle that AIs like GPT-4o can solve, is open-source, more private and doesn't depend on third-party servers for verification.
14+
15+
* **Why use this over GeeTest:** Cap doesn't require an account or API keys, has no usage limits, and is completely open-source with a simpler integration process. It also doesn't rely on slow, complex image-based puzzles that frustrate users

docs/guide/effectiveness.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Cap is designed to reduce spam and abuse on websites and web apps. While it won't block all spam, it's highly effective at keeping most bots away.
44

5-
## The PoW mechanism
5+
## How PoW works
66

7-
Cap uses a Proof-of-Work (PoW) system, similar to Friendly Captcha. Instead of simply verifying if you're human by analysing your mouse movement and interaction with the website, Cap creates a computational task that bots find hard to solve.
7+
Cap uses a Proof-of-Work (PoW) system, similar to Friendly Captcha and Altcha. Instead of simply verifying if you're human by analysing your mouse movement and interaction with the website, Cap creates a computational task that bots find hard to solve.
88

9-
When you verify yourself, Cap asks the server for multiple challenges (we use multiple challenges in order to help adjust difficulty levels and track progress more accurately), which include a unique salt and target. The server generates these challenges and sends them to the Cap widget. Using Web Workers and WebAssembly, Cap tries to find a challenge with a hash starting with a specific string for each challenge by combining the salt with a random string.
9+
When you verify yourself, Cap asks the server for multiple challenges (we use multiple challenges in order to help adjust difficulty levels and track progress more accurately), which include a unique salt and target. The server generates these challenges and sends them to the Cap widget. Using Web Workers and WASM, Cap tries to find a challenge with a hash starting with a specific string for each challenge by combining the salt with a random string.
1010

1111
Once solved, the widget sends the results back to the server for validation. If successful, the server gives a token that can be used to prove you're human. This extra complexity makes it much harder for simple bots to bypass.
1212

docs/guide/vulnerabilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# Vulnerabilities
2-
So far there have been no publicly disclosed vulnerabilities. If you find any, please let us know at https://github.com/tiagorangel1/cap/security/advisories
2+
So far there have been no publicly disclosed vulnerabilities. If you find any, please let us know [here](https://github.com/tiagorangel1/cap/security/advisories/new)

0 commit comments

Comments
 (0)