From 44432cbd5a3d6a52e411ccaccf8be633863fc143 Mon Sep 17 00:00:00 2001 From: hrj Date: Mon, 4 Apr 2022 21:47:49 +0530 Subject: [PATCH] Update `size` description --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ebc50da..abacd76 100644 --- a/README.md +++ b/README.md @@ -139,10 +139,10 @@ The service can be accessed using a simple HTTP API. - image/png - image/gif - (More to come) - - `size`: `Map` - - The dimensions of a captcha (Optional). It needs two more fields nested in this parameter - - `height`: `Int` - - `width`: `Int` + - `size`: String - + The dimensions of a captcha. It needs to be a string in the format `"widthxheight"` in pixels, and will be matched + with the `allowedSizes` config setting. Example: `size: "450x200"` which requests an image of width 450 and height + 200 pixels. - Returns: - `id`: `String` - The uuid of the captcha generated