Arav
/
justcaptcha
1
0
Fork 0
Code Issues Releases 6 Activity

README updated.

This commit is contained in:
Alexander Andreev 2023-01-08 17:38:51 +04:00
parent 275e3c500b
commit 49a64f553e
Signed by: Arav
GPG Key ID: 0388CC8FAA51063F
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3,15 +3,15 @@ justcaptcha ver. 2.0.0
A simple CAPTCHA service implementation. A simple CAPTCHA service implementation.
## Usage ## Service usage
justcaptchad -expiry 5m -listen /var/run/justcaptcha/c.sock justcaptchad -expiry 10m -listen /var/run/justcaptcha/sock
`-expiry` takes time for CAPTCHA to be valid for in format X{s,m,h}. `-expiry` takes time for CAPTCHA to be valid for in format X{s,m,h}.
`-listen` is `ip:port` or `/path/to/unix.sock` to listen on. `-listen` is `ip:port` or `/path/to/unix.sock` to listen on.
## API ## Service HTTP API
### Errors ### Errors
@ -33,7 +33,7 @@ It will return an ID of a new CAPTCHA in `text/plain`.
Responds with an image in JPEG format (`image/jpeg`). Responds with an image in JPEG format (`image/jpeg`).
An optional URL parameter `style=` set a name of a CAPTCHA style if it is An optional URL parameter `style=` set a name of a CAPTCHA style if it is
implemented by used CAPTCHA implementation. supported by CAPTCHA implementation.
#### HTTP codes #### HTTP codes
- `200` if exists - `200` if exists