📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
updated description and package version
Blue Mouse67c49f18a5b3
diff --git a/README.md b/README.mdindex c1f5c4e39..9fee2e902 100644--- a/README.md+++ b/README.md@@ -1,10 +1,45 @@<img src="https://swetrix.com/assets/logo_blue.svg" alt="" height="100" /># Swetrix CAPTCHA validator-TODO+This is a wrapper for the Swetrix CAPTCHA server-side validation API.\+It is used to validate the user's response to the CAPTCHA.\+Read more about server-side validation at https://docs.swetrix.com//captcha/server-side-validation-# Selfhosted API-TODO+# Installation+```bash+npm install @swetrix/captcha-validator+```++# Usage+You can use this package in your Node.js (or NestJS, ExpressJS, etc.) project to validate the user's response to the CAPTCHA.\+The package exports a single function `validateToken` which takes arguments listed below and returns a Promise.++| Argument | Type | Description | Required |+| --- | --- | --- | --- |+| token | string | The token returned by the CAPTCHA widget. | YES |+| secretKey | string | Your CAPTCHA project secret key. | YES |+| apiURL | string | The API URL to use (default: https://api.swetrix.com/captcha), this one may be used in case you're selfhosting the API. | NO |++Here's an example of how to use the package in your project:+```js+const { validateToken } = require('@swetrix/captcha-validator')+// or+import { validateToken } from '@swetrix/captcha-validator'++// somewhere inside the controller of your form where the CAPTCHA is used+validateToken(+ 'CAPTCHA_TOKEN',+ 'YOUR_SECRET_KEY',+).then((result) => {+ const [status, data] = result+ // status is a boolean, true if the token is valid, false otherwise+ // data is an error message if status is false+ console.log(status, data)+})+```++# License+This library is licenced under the MIT License - see the [LICENSE](LICENSE) file for details.# DonateYou can support the project by donating us at https://ko-fi.com/andriir \diff --git a/package.json b/package.jsonindex 3cf83ee88..0e10649d9 100644--- a/package.json+++ b/package.json@@ -1,6 +1,6 @@{"name": "@swetrix/captcha-validator",- "version": "0.0.5",+ "version": "1.0.0","description": "Swetrix CAPTCHA token validator package.","main": "dist/captcha-validator.cjs.js","module": "dist/captcha-validator.es5.js",