improve readme and fix license
This commit is contained in:
Tiago
-15
@@ -1,15 +0,0 @@
|
||||
Cap — A modern, lightning-quick PoW captcha
|
||||
Copyright © 2025 Tiago Rangel
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
@@ -1,39 +1,66 @@
|
||||
<img alt="Cap logo" src="https://capjs.js.org/logo.png" width="70">
|
||||
<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>
|
||||
|
||||
# cap — modern, lightning-quick PoW captcha
|
||||
<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://cap-starter.glitch.me">Demo</a>
|
||||
<span> • </span>
|
||||
<a href="https://github.com/tiagorangel1/cap/issues/new">Issues</a>
|
||||
<br />
|
||||
</div>
|
||||
|
||||
cap is a lightweight, modern open-source CAPTCHA alternative designed using SHA-256 PoW.
|
||||
### [Read the docs →](https://capjs.js.org)
|
||||
|
||||
| [documentation →](https://capjs.js.org) | [demo](https://cap-starter.glitch.me)
|
||||
|----------|----------|
|
||||
## 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>
|
||||
|
||||
[](https://www.npmjs.com/package/@cap.js/server) [](https://www.npmjs.com/package/@cap.js/widget) [](https://www.npmjs.com/package/@cap.js/solver) [](https://www.bestpractices.dev/projects/9920)
|
||||
Cap is built into 2 main parts:
|
||||
|
||||
<img alt="Cap captcha" src="./assets/thumb.png">
|
||||
- **[@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.
|
||||
|
||||
## why Cap?
|
||||
- **[@cap.js/server](https://capjs.js.org/guide/server.html)**: An extremely simple, zero-dependencies library that handles creating and validating challenges.
|
||||
|
||||
- ⚡️ **250x smaller than hCaptcha**
|
||||
cap's widget library 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 is self-hostable so you can customize both the backend & frontend — or you can just use CSS variables
|
||||
- 🤖 **PoW-based**
|
||||
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**
|
||||
floating mode keeps your CAPTCHA hidden until it's needed
|
||||
- 🌳 **Fully FOSS**
|
||||
completely open source under the Apache license 2.0 license
|
||||
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 FOSS**
|
||||
Completely open source under the Apache license 2.0 license.
|
||||
|
||||
## License
|
||||
Cap is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
|
||||
|
||||
## star history
|
||||
|
||||
[](https://www.star-history.com/#tiagorangel1/cap&Date)
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
<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" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
<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" style="width: 250px; height: 54px;" width="250" height="54" /></a>
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Reference in New Issue
Block a user