From d7e145a2eee3e76dd1daed93bde86ff938419318 Mon Sep 17 00:00:00 2001 From: realaravinth Date: Thu, 11 Mar 2021 11:53:37 +0530 Subject: [PATCH] doc links --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e2becd9..413a6c6 100644 --- a/README.md +++ b/README.md @@ -4,30 +4,29 @@ mCaptcha - PoW based DoS protection

-[![Documentation](https://img.shields.io/badge/docs-master-blue)](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html) -![CI (Linux)]() +[![Documentation](https://img.shields.io/badge/docs-master-yellow)](https://mcaptcha.github.io/mCaptcha/m_captcha/index.html) +[![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) [![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg)](http://www.gnu.org/licenses/agpl-3.0) +![CI (Linux)]()
-[![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) - - -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!