From 4f38dce02fe8b71e48e7dca3b06f7234bbd6861e Mon Sep 17 00:00:00 2001 From: Pihkaal Date: Sat, 11 Apr 2026 19:51:16 +0200 Subject: [PATCH] chore: update README --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0994526..dbc339f 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,29 @@ Simple, bullshit-free QR code generator with straightforward API. ## Stack -- [Nuxt 4](https://nuxt.com) + [Nuxt UI](https://ui.nuxt.com)a +- [Nuxt 4](https://nuxt.com) + [Nuxt UI](https://ui.nuxt.com) + +## API + +### `GET /api` - Generate a QR code + +Returns the QR code as an image file. + +| Parameter | Type | Required | Description | +|-----------|---------------------------|----------|-----------------------------------------------------| +| `content` | string | yes | Data to encode | +| `format` | `png` \| `jpeg` \| `webp` | no | Output format (default: `png`) | +| `logo` | string | no | Logo name to embed in the center (case-insensitive) | + +**Example:** +``` +GET /api?content=https://example.com&format=png&logo=github +``` + +### `GET /api/logos` - List available logos + +Returns a JSON array of available logo names. + +```json +["signal", "monero", "session", ...] +```