better docs and readme
This commit is contained in:
tiago
@@ -1,120 +1,48 @@
|
||||
<p align="center">
|
||||
<a href="https://capjs.js.org"><img alt="Cap — lightweight, modern open-source CAPTCHA" src="./assets/banner.png" width="100%"></a>
|
||||
</p>
|
||||
# <img src="https://github.com/tiagozip/cap/blob/main/docs/public/logo-small.webp?raw=true" alt="" align="left" width="40" height="40"> Cap
|
||||
|
||||
<div align="center">
|
||||
<a href="https://capjs.js.org/">Documentation</a>
|
||||
<span> • </span>
|
||||
<a href="https://capjs.js.org/guide/">Quickstart</a>
|
||||
<span> • </span>
|
||||
<a href="https://capjs.js.org/guide/demo.html">Demo</a>
|
||||
<span> • </span>
|
||||
<a href="https://github.com/tiagozip/cap/issues/new">Issues</a>
|
||||
<br />
|
||||
</div>
|
||||
Cap is a lightweight, modern open-source CAPTCHA alternative using <a href="https://capjs.js.org/guide/effectiveness.html">SHA-256 proof-of-work</a>. It's fast, private, and extremely simple to integrate.
|
||||
|
||||
### [Read the docs →](https://capjs.js.org)
|
||||
## Documentation
|
||||
|
||||
[Read the Cap docs](https://capjs.js.org), try the [demo](https://capjs.js.org/guide/demo.html) or read the [feature comparison](https://capjs.js.org/guide/alternatives.html)
|
||||
|
||||
## What is Cap?
|
||||
|
||||
Cap is a lightweight, modern open-source CAPTCHA alternative using SHA-256 proof-of-work. It's fast, private, and extremely simple to integrate. <a href="https://capjs.js.org/guide/effectiveness.html">Learn more about proof-of-work here.</a>
|
||||
Cap is the modern, open-source alternative to traditional CAPTCHAs that uses proof-of-work instead of annoying visual puzzles.
|
||||
|
||||
Cap is built into 2 main parts:
|
||||
It's built with JavaScript and Rust and has no dependencies. You can either run it on any JavaScript runtime (Bun, Node.js, Deno), or use the standalone mode with Docker.
|
||||
|
||||
- **[@cap.js/widget](https://capjs.js.org/guide/widget.html)**: A small JavaScript library that renders the CAPTCHA and handles solving it using Web Workers and WASM.
|
||||
Cap is built into 2 main parts. The [widget](https://capjs.js.org/guide/widget.html) is a small client-side JavaScript library using custom components and WASM that renders the CAPTCHA and solves the challenge.
|
||||
|
||||
- **[@cap.js/server](https://capjs.js.org/guide/server.html)**: An extremely simple, zero-dependencies library that handles creating and validating challenges.
|
||||
The [Standalone Server](https://capjs.js.org/guide/standalone.html) is a Docker image that helps you use Cap with any language or framework. As an alternative, if your server-side uses JavaScript, you can use the lighter [server](https://capjs.js.org/guide/server.html) library.
|
||||
|
||||
There are also some other helpful packages:
|
||||
|
||||
- **[M2M](https://capjs.js.org/guide/solver.html)**: Server-side solver for Cap challenges, useful for protecting API endpoints that you still want public. This doesn't bypass the actual proof-of-work.
|
||||
|
||||
- **[@cap.js/cli](https://capjs.js.org/guide/cli.html)**: Command-line interface for solving CAPTCHAs made with Cap. It's mainly designed for testing and when you need to solve these CAPTCHAs in a browser without JavaScript support.
|
||||
|
||||
- **[Standalone mode](https://capjs.js.org/guide/standalone.html)**: Docker image that helps you use Cap with any language or framework. It runs a simple REST API that can be used to create and validate challenges and an interactive UI to manage your keys.
|
||||
|
||||
- **@cap.js/wasm**: Experimental WASM solvers built using Rust.
|
||||
|
||||
We also provide a middleware for a Cloudflare browser checkpoint-like experience:
|
||||
|
||||
- [@cap.js/checkpoint-hono](https://capjs.js.org/guide/middleware/hono.html)
|
||||
- [@cap.js/checkpoint-express](https://capjs.js.org/guide/middleware/express.html)
|
||||
- [@cap.js/middleware-elysia](https://capjs.js.org/guide/middleware/elysia.html)
|
||||
- more coming soon!
|
||||
|
||||
It's designed to be a drop-in replacement for existing CAPTCHA solutions, with a focus on performance and UX.
|
||||
|
||||
Cap is built with JavaScript, runs on any JS runtime (Bun, Node.js, Deno), and has no dependencies. If you're not using any JS runtime, you can also use the standalone mode with Docker, which relies entirely on a simple REST API to create and validate challenges.
|
||||
Cap also has a [M2M library](https://capjs.js.org/guide/solver.html) that implements a custom proof-of-work solver for protecting API endpoints that you still want public.
|
||||
|
||||
## Why Cap?
|
||||
|
||||
- **250x smaller than hCaptcha**
|
||||
`@cap.js/widget` is extremely small, only 12kb minified and brotli'd.
|
||||
- **Private**
|
||||
Cap's usage of proof-of-work eliminates the need for any tracking, fingerprinting or data collection.
|
||||
~20kb, zero dependencies, loads in milliseconds
|
||||
- **Privacy-first**
|
||||
Cap doesn't send any telemetry back to our servers
|
||||
- **Fully customizable**
|
||||
Cap's self-hostable so you can customize both the backend & frontend — or you can just use CSS variables
|
||||
Change the colors, size, position, icons and more with CSS variables
|
||||
- **Proof-of-work**
|
||||
Cap uses proof-of-work instead of complex puzzles, making it easier for humans and harder for bots
|
||||
Your users no longer have to waste time solving visual puzzles.
|
||||
- **Standalone mode**
|
||||
Cap offers a standalone mode with Docker, allowing you to use it with languages other than JS.
|
||||
- **Invisible mode**
|
||||
Cap can run invisibly in the background using a simple JS API.
|
||||
- **Floating mode**
|
||||
Cap's floating mode keeps your CAPTCHA hidden until it's needed.
|
||||
- **Fully open-source**
|
||||
Completely open source under the Apache license 2.0 license.
|
||||
Run Cap anywhere with a Docker container with analytics & more
|
||||
- **Invisible**
|
||||
Hide Cap's widget and solve challenges in the background
|
||||
- **M2M**
|
||||
Keep your APIs protected while accessible to friendly robots
|
||||
- **Open-source**
|
||||
Completely free & open-source under the Apache 2.0 license
|
||||
|
||||
It's ideal for:
|
||||
|
||||
- Protecting APIs from bots
|
||||
- Preventing spam on forms
|
||||
- Blocking automated login attempts
|
||||
- Securing free-tier abuse
|
||||
|
||||
## Feature comparison
|
||||
|
||||
| CAPTCHA | Open-source | Free | Private | Fast to solve | Easy for humans | Small error rate | Checkpoint support | GDPR/CCPA Compliant | Customizable | Hard for bots | Easy to integrate |
|
||||
| :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- |
|
||||
| **Cap** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 🟨 | ✅ |
|
||||
| Cloudflare Turnstile | ❌ | ✅ | 🟨 | 🟨 | ✅ | ❌ | 🟨 | ✅ | ❌ | 🟨 | ✅ |
|
||||
| reCAPTCHA | ❌ | 🟨 | ❌ | ✅ | ❌ | 🟨 | ❌ | 🟨 | ❌ | ❌ | ✅ |
|
||||
| hCAPTCHA | ❌ | 🟨 | 🟨 | ❌ | ❌ | 🟨 | ❌ | 🟨 | ❌ | 🟨 | ✅ |
|
||||
| Altcha | ✅ | ✅ | ✅ | 🟨 | ✅ | ✅ | ❌ | ✅ | ✅ | 🟨 | 🟨 |
|
||||
| FriendlyCaptcha | ❌ | ❌ | ✅ | 🟨 | ✅ | ✅ | ❌ | ✅ | ✅ | 🟨 | 🟨 |
|
||||
| MTCaptcha | ❌ | 🟨 | 🟨 | ❌ | ❌ | 🟨 | ❌ | ✅ | ❌ | ❌ | 🟨 |
|
||||
| GeeTest | ❌ | ❌ | ❌ | 🟨 | 🟨 | 🟨 | ❌ | ✅ | ❌ | 🟨 | 🟨 |
|
||||
| Arkose Labs | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | 🟨 | ❌ | ❌ |
|
||||
|
||||
## Alternatives
|
||||
|
||||
Cap is a modern alternative to:
|
||||
|
||||
- [reCAPTCHA](https://www.google.com/recaptcha/about/)
|
||||
- [hCaptcha](https://www.hcaptcha.com/)
|
||||
- [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/)
|
||||
|
||||
But unlike them, Cap is **computation-bound, not tracking-bound**.
|
||||
Cap is a great alternative to [reCAPTCHA](https://www.google.com/recaptcha/about/), [hCaptcha](https://www.hcaptcha.com/) and [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/)
|
||||
|
||||
## License
|
||||
|
||||
Cap is licensed under the Apache License 2.0.
|
||||
Apache 2.0
|
||||
|
||||
---
|
||||
Copyright (c) 2025–present tiago
|
||||
|
||||
[](https://www.bestpractices.dev/projects/9920)
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cap-5" target="_blank">
|
||||
<img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=955605&theme=neutral&period=daily&t=1745311983202" alt="Cap - A lightweight, modern open-source captcha | Product Hunt" width="250" height="54" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-cap-5" target="_blank">
|
||||
<img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=955605&theme=neutral&period=monthly&topic_id=93&t=1746123375051" alt="Cap - A lightweight, modern open-source captcha | Product Hunt" width="250" height="54" />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
[](https://www.bestpractices.dev/projects/9920) [](https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-cap-5)
|
||||
+23
-86
@@ -49,108 +49,45 @@ features:
|
||||
|
||||
## What is Cap?
|
||||
|
||||
Cap is a lightweight, modern open-source CAPTCHA alternative using SHA-256 proof-of-work. It's fast, private, and extremely simple to integrate. <a href="https://capjs.js.org/guide/effectiveness.html">Learn more about proof-of-work here.</a>
|
||||
Cap is the modern, open-source alternative to traditional CAPTCHAs that uses proof-of-work instead of annoying visual puzzles.
|
||||
|
||||
Cap is built into 2 main parts:
|
||||
It's built with JavaScript and Rust and has no dependencies. You can either run it on any JavaScript runtime (Bun, Node.js, Deno), or use the standalone mode with Docker.
|
||||
|
||||
- **[@cap.js/widget](https://capjs.js.org/guide/widget.html)**: A small JavaScript library that renders the CAPTCHA and handles solving it using Web Workers and WASM.
|
||||
Cap is built into 2 main parts. The [widget](https://capjs.js.org/guide/widget.html) is a small client-side JavaScript library using custom components and WASM that renders the CAPTCHA and solves the challenge.
|
||||
|
||||
- **[@cap.js/server](https://capjs.js.org/guide/server.html)**: An extremely simple, zero-dependencies library that handles creating and validating challenges.
|
||||
The [Standalone Server](https://capjs.js.org/guide/standalone.html) is a Docker image that helps you use Cap with any language or framework. As an alternative, if your server-side uses JavaScript, you can use the lighter [server](https://capjs.js.org/guide/server.html) library.
|
||||
|
||||
There are also some other helpful packages:
|
||||
|
||||
- **[M2M](https://capjs.js.org/guide/solver.html)**: Server-side solver for Cap challenges, useful for protecting API endpoints that you still want public. This doesn't bypass the actual proof-of-work.
|
||||
|
||||
- **[@cap.js/cli](https://capjs.js.org/guide/cli.html)**: Command-line interface for solving CAPTCHAs made with Cap. It's mainly designed for testing and when you need to solve these CAPTCHAs in a browser without JavaScript support.
|
||||
|
||||
- **[Standalone mode](https://capjs.js.org/guide/standalone.html)**: Docker image that helps you use Cap with any language or framework. It runs a simple REST API that can be used to create and validate challenges and an interactive UI to manage your keys.
|
||||
|
||||
- **@cap.js/wasm**: WASM solvers for Node and Web built with Rust.
|
||||
|
||||
We also provide a middleware for a Cloudflare browser checkpoint-like experience:
|
||||
|
||||
- [@cap.js/checkpoint-hono](https://capjs.js.org/guide/middleware/hono.html)
|
||||
- [@cap.js/checkpoint-express](https://capjs.js.org/guide/middleware/express.html)
|
||||
- [@cap.js/middleware-elysia](https://capjs.js.org/guide/middleware/elysia.html)
|
||||
- more coming soon!
|
||||
|
||||
It's designed to be a drop-in replacement for existing CAPTCHA solutions, with a focus on performance and UX.
|
||||
|
||||
Cap is built with JavaScript, runs on any JS runtime (Bun, Node.js, Deno), and has no dependencies. If you're not using any JS runtime, you can also use the standalone mode with Docker, which relies entirely on a simple REST API to create and validate challenges.
|
||||
Cap also has a [M2M library](https://capjs.js.org/guide/solver.html) that implements a custom proof-of-work solver for protecting API endpoints that you still want public.
|
||||
|
||||
## Why Cap?
|
||||
|
||||
- **250x smaller than hCaptcha**
|
||||
`@cap.js/widget` is extremely small, only 12kb minified and brotli'd.
|
||||
- **Private**
|
||||
Cap's usage of proof-of-work eliminates the need for any tracking, fingerprinting or data collection.
|
||||
~20kb, zero dependencies, loads in milliseconds
|
||||
- **Privacy-first**
|
||||
Cap doesn't send any telemetry back to our servers
|
||||
- **Fully customizable**
|
||||
Cap's self-hostable so you can customize both the backend & frontend — or you can just use CSS variables
|
||||
Change the colors, size, position, icons and more with CSS variables
|
||||
- **Proof-of-work**
|
||||
Cap uses proof-of-work instead of complex puzzles, making it easier for humans and harder for bots
|
||||
Your users no longer have to waste time solving visual puzzles.
|
||||
- **Standalone mode**
|
||||
Cap offers a standalone mode with Docker, allowing you to use it with languages other than JS.
|
||||
- **Invisible mode**
|
||||
Cap can run invisibly in the background using a simple JS API.
|
||||
- **Floating mode**
|
||||
Cap's floating mode keeps your CAPTCHA hidden until it's needed.
|
||||
- **Fully open-source**
|
||||
Completely open source under the Apache license 2.0 license.
|
||||
Run Cap anywhere with a Docker container with analytics & more
|
||||
- **Invisible**
|
||||
Hide Cap's widget and solve challenges in the background
|
||||
- **M2M**
|
||||
Keep your APIs protected while accessible to friendly robots
|
||||
- **Open-source**
|
||||
Completely free & open-source under the Apache 2.0 license
|
||||
|
||||
It's ideal for:
|
||||
It's ideal for protecting APIs from bots, preventing spam on forms, blocking automated signup attempts and securing free-tier abuse.
|
||||
|
||||
- Protecting APIs from bots
|
||||
- Preventing spam on forms
|
||||
- Blocking automated login attempts
|
||||
- Securing free-tier abuse
|
||||
|
||||
## Feature comparison
|
||||
|
||||
| CAPTCHA | Open-source | Free | Private | Fast to solve | Easy for humans | Small error rate | Checkpoint support | GDPR/CCPA Compliant | Customizable | Hard for bots | Easy to integrate |
|
||||
| :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- | :-- |
|
||||
| **Cap** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 🟨 | ✅ |
|
||||
| Cloudflare Turnstile | ❌ | ✅ | 🟨 | 🟨 | ✅ | ❌ | 🟨 | ✅ | ❌ | 🟨 | ✅ |
|
||||
| reCAPTCHA | ❌ | 🟨 | ❌ | ✅ | ❌ | 🟨 | ❌ | 🟨 | ❌ | ❌ | ✅ |
|
||||
| hCAPTCHA | ❌ | 🟨 | 🟨 | ❌ | ❌ | 🟨 | ❌ | 🟨 | ❌ | 🟨 | ✅ |
|
||||
| Altcha | ✅ | ✅ | ✅ | 🟨 | ✅ | ✅ | ❌ | ✅ | ✅ | 🟨 | 🟨 |
|
||||
| FriendlyCaptcha | ❌ | ❌ | ✅ | 🟨 | ✅ | ✅ | ❌ | ✅ | ✅ | 🟨 | 🟨 |
|
||||
| MTCaptcha | ❌ | 🟨 | 🟨 | ❌ | ❌ | 🟨 | ❌ | ✅ | ❌ | ❌ | 🟨 |
|
||||
| GeeTest | ❌ | ❌ | ❌ | 🟨 | 🟨 | 🟨 | ❌ | ✅ | ❌ | 🟨 | 🟨 |
|
||||
| Arkose Labs | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ | 🟨 | ❌ | ❌ |
|
||||
|
||||
## Alternatives
|
||||
|
||||
Cap is a modern alternative to:
|
||||
|
||||
- [reCAPTCHA](https://www.google.com/recaptcha/about/)
|
||||
- [hCaptcha](https://www.hcaptcha.com/)
|
||||
- [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/)
|
||||
|
||||
But unlike them, Cap is [**computation-bound, not tracking-bound**](./guide/workings.md).
|
||||
|
||||
[Read more about alternatives](./guide/alternatives.md)
|
||||
Cap is a great alternative to [reCAPTCHA](https://www.google.com/recaptcha/about/), [hCaptcha](https://www.hcaptcha.com/) and [Cloudflare Turnstile](https://developers.cloudflare.com/turnstile/). Check out the [feature comparison](https://capjs.js.org/guide/alternatives.html) to see how Cap compares to other CAPTCHAs.
|
||||
|
||||
## License
|
||||
|
||||
Cap is licensed under the Apache License 2.0.
|
||||
Apache 2.0
|
||||
|
||||
Copyright (c) 2025–present tiago
|
||||
|
||||
---
|
||||
|
||||
[](https://www.bestpractices.dev/projects/9920)
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cap-5" target="_blank">
|
||||
<img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=955605&theme=neutral&period=daily&t=1745311983202" alt="Cap - A lightweight, modern open-source captcha | Product Hunt" width="250" height="54" />
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-cap-5" target="_blank">
|
||||
<img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=955605&theme=neutral&period=monthly&topic_id=93&t=1746123375051" alt="Cap - A lightweight, modern open-source captcha | Product Hunt" width="250" height="54" />
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
[](https://www.bestpractices.dev/projects/9920) [](https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-cap-5)
|
||||
Reference in New Issue
Block a user