update readme

This commit is contained in:
brooke 2025-03-08 00:08:53 -05:00
parent 7aabc1f1c8
commit 38768fcbf5

View File

@ -29,7 +29,9 @@
4get does not support corporate captcha providers (ie. reCaptcha, hCaptcha, etc.) instead it employs a very simple image captcha based on user provided images. Images must be png, 100x100 in size, and named in order (ie. 1.png, 2.png, 3.png, etc.)
Images are placed in a directory with a name of the person, place, or thing the user is expected to select. Provide 4get only with images that match the folder name. go to `https://4get.ca/web?s=test` for some examples
Images are segmented into datasets which are directories with a name of the person, place, or thing that are the subject of the images. Provide 4get only with images that match the name of your dataset. go to `https://4get.ca/web?s=test` for an examples
Image datasets are then defined in your app's config as `CAPTCHA_DATASET` (ex: `['birds', 2263],['fumo_plushies', 1006],['minecraft', 848]`)
example directory structure: