mcaptcha-api-js/README.md
Aravinth Manivannan 4916bc4458
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/tag/woodpecker Pipeline was successful
feat: add readme
2024-01-03 01:36:56 +05:30

27 lines
687 B
Markdown

[![status-badge](https://ci.batsense.net/api/badges/108/status.svg)](https://ci.batsense.net/repos/108)
---
# mcaptcha-api-js: Library to interact with with mCaptcha API
This library provides a convenient interface to validate [mCaptcha authorization
tokens](https://mcaptcha.org/docs/webmasters/terminology#authorization-token) presented by
Visitors against your mCaptcha instance.
## Install
```bash
npm i @mcaptcha/mcaptcha-api-js
```
## Example
```javascript
let mcaptcha = new MCaptcha(
"sitekeyfromdashboard",
"settingsfromdashboardsettingspage",
"https://mcaptcha.example.org"
);
let res = await mcaptcha.verify("token");
console.log(`verification status: ${res}`);
```