doc links
This commit is contained in:
parent
8c4f885a85
commit
d7e145a2ee
1 changed files with 20 additions and 12 deletions
32
README.md
32
README.md
|
@ -4,30 +4,29 @@
|
|||
<strong>mCaptcha - PoW based DoS protection</strong>
|
||||
</p>
|
||||
|
||||
[](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
|
||||
/badge.svg>)
|
||||
[](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
|
||||
[](https://mcaptcha.org/docs/api/mcaptcha-system)
|
||||
[](https://deps.rs/repo/github/mCaptcha/mCaptcha)
|
||||
[](http://www.gnu.org/licenses/agpl-3.0)
|
||||
/badge.svg>)
|
||||
<br />
|
||||
[](https://codecov.io/gh/mCaptcha/mCaptcha)
|
||||
[](https://codecov.io/gh/mCaptcha/mCaptcha)
|
||||
[](https://matrix.to/#/+mcaptcha:matrix.batsense.net)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
mCaptcha uses SHA256 based proof-of-work(PoW) to rate limit users.
|
||||
mCaptcha uses SHA256 based proof-of-work(PoW) to rate limit users.
|
||||
|
||||
If someone wants to hammer your site, they will have to do more work to
|
||||
send requests than your server will have to do to respond to their
|
||||
request.
|
||||
|
||||
>**NOTE:** `0.1` is out, expect breaking changes as ergonomics and
|
||||
performance is improved. Checkout [changelog](./CHANGELOG.md) for
|
||||
changes and migration pointers.
|
||||
|
||||
> **NOTE:** `0.1` is out, expect breaking changes as ergonomics and
|
||||
> performance is improved. Checkout [changelog](./CHANGELOG.md) for
|
||||
> changes and migration pointers.
|
||||
|
||||
## Why use mCaptcha?
|
||||
|
||||
- Free software, privacy focused
|
||||
- Seamless UX - No more annoying captchas!
|
||||
- IP address independent(sort of) - your users are behind a NAT? We got you covered!
|
||||
|
@ -44,22 +43,31 @@ database frequently wiped).
|
|||
|
||||
Be sure to open dev tools' network tab to witness the magic!
|
||||
|
||||
## Usage:
|
||||
## Documentation
|
||||
|
||||
- [master-branch](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
|
||||
- [All published versions](https://mcaptcha.org/docs/api/mcaptcha-system)
|
||||
|
||||
## Usage
|
||||
|
||||
mCaptcha is made up of three components:
|
||||
|
||||
#### 1. Front-end library
|
||||
|
||||
We have a WASM library now, Android and iOS libraries soon
|
||||
|
||||
#### 2. Back-end library
|
||||
|
||||
We have Rust library, other languages will have support soon
|
||||
|
||||
#### 3. Rate limiting service
|
||||
Under development.
|
||||
|
||||
Under development.
|
||||
|
||||
A paid, managed service will be made available soon but
|
||||
I([@realaravinth](https://batsense.net)) encourage you guys to
|
||||
self-host. Go decentralisation!
|
||||
|
||||
## Contributing
|
||||
|
||||
yes please!
|
||||
|
|
Loading…
Reference in a new issue