Add requirements

This commit is contained in:
Tiago
2025-03-04 11:30:35 +00:00
parent f25d194706
commit 814bd864b1
3 changed files with 11 additions and 1 deletions
+5
View File
@@ -5,6 +5,11 @@ outline: deep
# Quickstart
[[toc]]
## Requirements
* **Server-side library:** At least Node 14. Most modern Bun or Deno versions should work too. If you're using Glitch, make sure to set node 14 or higher in your `engines` field in `package.json`
* **Client-side widget:** All modern browsers should be supported, but the build script specifically targets the last 10 versions of Chrome, Firefox, Safari and Edge.
## Client-side
Start by adding importing the Cap widget library from a CDN:
+2 -1
View File
@@ -7,7 +7,8 @@ npm i @cap.js/server
```
> [!NOTE]
> It is recommended to use at least Node.js 14 or Bun 1.0.0. You might experience multiple issues on older versions of these runtimes.
> It is recommended to use at least Node.js 14 or Bun 1.0.0. You might experience multiple issues on older versions of these runtimes.
> If you're using Glitch, make sure to set node 14 or higher in your `engines` field in `package.json`
## Example code
+4
View File
@@ -1,5 +1,9 @@
# @cap.js/widget
> [!NOTE]
> **Requirements:** All modern browsers should be supported, but the build script specifically targets the last 10 versions of Chrome, Firefox, Safari and Edge.
`@cap.js/widget` is Cap's client-side library. It includes the `cap-widget` web component, the invisible mode and the Captcha solver. It is recommended to use unpkg to install it:
```html