realaravinth/tmp
2
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc links

Browse source
This commit is contained in:
Aravinth Manivannan 2021-03-11 11:53:37 +05:30
parent 8c4f885a85
commit d7e145a2ee
Signed by: realaravinth
GPG key ID: AD9F0F08E855ED88
1 changed files with 20 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -4,30 +4,29 @@
<strong>mCaptcha - PoW based DoS protection</strong> <strong>mCaptcha - PoW based DoS protection</strong>
</p> </p>
[![Documentation](https://img.shields.io/badge/docs-master-blue)](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html) [![Documentation](https://img.shields.io/badge/docs-master-yellow)](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html)
![CI (Linux)](<https://github.com/mCaptcha/mCaptcha/workflows/CI%20(Linux)/badge.svg>) [![Documentation](https://img.shields.io/badge/docs-0.1.0-blue)](https://mcaptcha.org/docs/api/mcaptcha-system)
[![dependency status](https://deps.rs/repo/github/mCaptcha/mCaptcha/status.svg)](https://deps.rs/repo/github/mCaptcha/mCaptcha) [![dependency status](https://deps.rs/repo/github/mCaptcha/mCaptcha/status.svg)](https://deps.rs/repo/github/mCaptcha/mCaptcha)
[![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg)](http://www.gnu.org/licenses/agpl-3.0) [![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg)](http://www.gnu.org/licenses/agpl-3.0)
![CI (Linux)](<https://github.com/mCaptcha/mCaptcha/workflows/CI%20(Linux)/badge.svg>)
<br /> <br />
[![codecov](https://codecov.io/gh/mCaptcha/mCaptcha/branch/master/graph/badge.svg)](https://codecov.io/gh/mCaptcha/mCaptcha) [![codecov](https://codecov.io/gh/mCaptcha/mCaptcha/branch/master/graph/badge.svg)](https://codecov.io/gh/mCaptcha/mCaptcha)
[![Documentation](https://img.shields.io/badge/matrix-community-purple)](https://matrix.to/#/+mcaptcha:matrix.batsense.net) [![Documentation](https://img.shields.io/badge/matrix-community-purple)](https://matrix.to/#/+mcaptcha:matrix.batsense.net)
</div> </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 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 send requests than your server will have to do to respond to their
request. request.
>**NOTE:** `0.1` is out, expect breaking changes as ergonomics and > **NOTE:** `0.1` is out, expect breaking changes as ergonomics and
performance is improved. Checkout [changelog](./CHANGELOG.md) for > performance is improved. Checkout [changelog](./CHANGELOG.md) for
changes and migration pointers. > changes and migration pointers.
## Why use mCaptcha? ## Why use mCaptcha?
- Free software, privacy focused - Free software, privacy focused
- Seamless UX - No more annoying captchas! - Seamless UX - No more annoying captchas!
- IP address independent(sort of) - your users are behind a NAT? We got you covered! - 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! 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: mCaptcha is made up of three components:
#### 1. Front-end library #### 1. Front-end library
We have a WASM library now, Android and iOS libraries soon We have a WASM library now, Android and iOS libraries soon
#### 2. Back-end library #### 2. Back-end library
We have Rust library, other languages will have support soon We have Rust library, other languages will have support soon
#### 3. Rate limiting service #### 3. Rate limiting service
Under development.
Under development.
A paid, managed service will be made available soon but A paid, managed service will be made available soon but
I([@realaravinth](https://batsense.net)) encourage you guys to I([@realaravinth](https://batsense.net)) encourage you guys to
self-host. Go decentralisation! self-host. Go decentralisation!
## Contributing ## Contributing
yes please! yes please!