Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dzmitry-duboyski committed Feb 25, 2023
1 parent 827fbaa commit b40dd08
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<u><b>[English](README.md)</b></u> | [Spanish](README.es.md) | [中国语文科](README.zh.md) | [Русский](README.ru.md)
<p align="center">
<img src="https://user-images.githubusercontent.com/38065632/217352869-1f156919-1ab9-4ea2-9bbb-f4a8dcf2a9e1.jpg">
</p>
Expand All @@ -8,7 +9,7 @@


## Description
A wrapper around the 2captcha API. This wrapper support reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile.
A wrapper around the [2captcha](https://2captcha.com/?from=16653706) API. This wrapper support reCAPTCHA V2, reCAPTCHA V3, hCaptcha, Arkose Labs FunCaptcha, image captcha, Geetest, Geetest V4, Yandex Smart Captcha, Lemin captcha, Amazon WAF, Cloudflare Turnstile.

[2captcha](https://2captcha.com/?from=16653706) is a service that solves many different types of captchas, this library serves as a wrapper around their API to bring easy, promise-based functionality to NodeJS. This libary specilizes in concurrent solves, and bulk-api usage.

Expand Down Expand Up @@ -62,10 +63,10 @@ yarn add 2captcha-ts
### reCAPTCHA:
```js
const Captcha = require("2captcha-ts")
// A new 'solver' instance with our API key
// A new 'solver' instance with your API key
const solver = new Captcha.Solver("<Your 2captcha api key>")

/* Example reCAPTCHA Website */
// Example reCAPTCHA Website
solver.recaptcha({
pageurl: 'https://2captcha.com/demo/recaptcha-v2',
googlekey: '6LfD3PIbAAAAAJs_eEHvoOl75_83eXSqpPSRFJ_u'
Expand Down Expand Up @@ -137,7 +138,7 @@ solver.imageCaptcha(imageBase64, { numeric: 4, min_len: 5, max_len: 5 })
const Captcha = require("2captcha-ts")
const solver = new Captcha.Solver("<Your 2captcha api key>")

// Read more about `challenge` https://2captcha.com/2captcha-api#solving_geetest
// Read more about `challenge` on the page https://2captcha.com/p/geetest
solver.geetest({
pageurl: 'https://2captcha.com/demo/geetest',
gt: '81388ea1fc187e0c335c0a8907ff2625',
Expand Down Expand Up @@ -280,7 +281,10 @@ The latest version of the code base will always be under the '**next**' branch!
* [How to bypass Geetest v4 CAPTCHA](https://2captcha.com/blog/geetest-v4-support?from=16653706)
* [Automatic ReCAPTCHA V3 resolution - a tutorial for developers and customers](https://2captcha.com/blog/recaptcha-v3-automatic-resolution?from=16653706)
* Finding Sitekey <a href="./docs/hcaptcha.md">hCaptcha</a>
---
## Usage examples with source code and description
* [Solving GeeTest Captcha using Puppeteer](https://github.com/dzmitry-duboyski/GeeTest-demo)

---

This project is a fork of this [package](https://www.npmjs.com/package/2captcha). In this version, new types of captchas have been added and the method of passing captcha parameters has been changed ({ using an object }) and etc.
This project is a fork of this [package](https://www.npmjs.com/package/2captcha). In this version, new types of captchas have been added and the method of passing captcha parameters has been changed ({ using an object }) and etc. You can read more about the changes made [here](https://github.com/dzmitry-duboyski/2captcha-ts/releases).

0 comments on commit b40dd08

Please sign in to comment.