diff --git a/README.md b/README.md index 803b8f7..50950e9 100644 --- a/README.md +++ b/README.md @@ -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`. 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`. \ No newline at end of file +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) | \ No newline at end of file diff --git a/readme/v1.jpg b/readme/v1.jpg new file mode 100644 index 0000000..3704e51 Binary files /dev/null and b/readme/v1.jpg differ