feat: add readme
This commit is contained in:
parent
253b93dce9
commit
4916bc4458
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
[![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}`);
|
||||
```
|
Loading…
Reference in a new issue