swcs/cap
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docs homepage and readme

Browse Source
This commit is contained in:
Tiago
2025-04-22 13:14:02 +01:00
parent a6a6e6db33
commit 4dd0ef3a13
2 changed files with 67 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -6
View File
@@ -32,7 +32,6 @@ There are also some other helpful packages:
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.
## Why Cap?
@@ -51,16 +50,31 @@ Cap is built with JavaScript, runs on any JS runtime (Bun, Node.js, Deno), and h
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 FOSS**
- **Fully open-source**
Completely open source under the Apache license 2.0 license.
It's ideal for:
- Protecting APIs from bots
- Preventing spam on forms
- Blocking automated login attempts
- Securing free-tier abuse
## 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**.
## License
Cap is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
## star history
***
[![Star History Chart](https://api.star-history.com/svg?repos=tiagorangel1/cap&type=Date)](https://www.star-history.com/#tiagorangel1/cap&Date)
---
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9920/badge)](https://www.bestpractices.dev/projects/9920)
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cap&#0045;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&#0032;lightweight&#0044;&#0032;modern&#0032;open&#0045;source&#0032;captcha | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
docs/index.md
+47 -11
View File
@@ -49,12 +49,42 @@ features:
## What is Cap?
Cap is a lightweight, open-source CAPTCHA alternative that uses SHA-256-based proof-of-work to verify real users and block bots — no cookies, no trackers.
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>
- ✅ Privacy-friendly
- ⚡ Fast and lightweight
- 🔓 Fully open source (Apache 2.0)
- 🧩 Pluggable widget + solver + backend
Cap is built into 2 main parts:
- **[@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.js/server](https://capjs.js.org/guide/server.html)**: An extremely simple, zero-dependencies library that handles creating and validating challenges.
There are also some other helpful packages:
- **[@cap.js/solver](https://capjs.js.org/guide/solver.html)**: Server-side solver for the CAPTCHA in case you want to use machine-to-machine.
- **[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.
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.
## 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.
- **Fully customizable**
Cap's self-hostable so you can customize both the backend & frontend — or you can just use CSS variables
- **Proof-of-work**
Cap uses proof-of-work instead of complex puzzles, making it easier for humans and harder for bots
- **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.
It's ideal for:
@@ -63,16 +93,22 @@ It's ideal for:
- Blocking automated login attempts
- Securing free-tier abuse
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.
Zero dependencies, developer-friendly, and effective against spam, DDoS, and automation.
## Alternatives
Cap.js is a modern alternative to:
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**.
But unlike them, Cap is **computation-bound, not tracking-bound**.
## License
Cap is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
***
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9920/badge)](https://www.bestpractices.dev/projects/9920)
<a href="https://www.producthunt.com/posts/cap-5?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cap&#0045;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&#0032;lightweight&#0044;&#0032;modern&#0032;open&#0045;source&#0032;captcha | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>