From 4916bc445807e3803d3fd784a05256d5fd90b268 Mon Sep 17 00:00:00 2001
From: Aravinth Manivannan <realaravinth@batsense.net>
Date: Wed, 3 Jan 2024 01:36:56 +0530
Subject: [PATCH] feat: add readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..40183c5
--- /dev/null
+++ b/README.md
@@ -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}`);
+```