blek
/
freeptcha
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add examples

This commit is contained in:
b1ek 2023-06-23 23:23:43 +10:00
parent bfe554863c
commit 874a28552b
Signed by: blek
GPG Key ID: 14546221E3595D0C
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -5,4 +5,11 @@ Freeptcha is a completely free, open source and portable captcha generator.
To deploy a local instance, write a `.env`, install the packages and run `yarn dev`. To deploy a local instance, write a `.env`, install the packages and run `yarn dev`.
Deploying to production is not supported (yet), but to run with the most optimizations, Deploying to production is not supported (yet), but to run with the most optimizations,
set `APP_DEBUG` to `false` in `.env`, and run the file directly: `node index.js`. set `APP_DEBUG` to `false` in `.env`, and run the file directly: `node index.js`.
# Examples
Below are captchas generated by this. To generate a captcha, deploy an instance send a GET `/captcha/v{version}/{text}`, with `version` being the captcha version and `text` being the captcha text.
| Captcha version | Image |
| --- | --- |
| 1 | ![](./readme/v1.jpg) |

BIN
readme/v1.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB