From d4dd3c7b1872954f7db31b1de37fd641a03457c6 Mon Sep 17 00:00:00 2001
From: Joao Victor <geonizeli@hey.com>
Date: Wed, 10 Dec 2025 18:59:19 -0300
Subject: [PATCH] add README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cbc74b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# HEIC to JPG Converter API
+
+- Convert HEIC files to JPG via HTTP POST request.
+
+**Example using curl:**
+
+```bash
+curl -X POST -F "file=@/path/to/image.heic" http://localhost:5000/convert-heic-to-jpg --output converted.jpg
+```
+
+## Deployment
+I am running it like this:
+
+```yaml
+version: '3.8'
+
+services:
+  api:
+    image: ghcr.io/loficafe-zx/convert-heic-to-jpg-api:master
+    ports:
+      - "5000:5000"
+    restart: unless-stopped
+```
\ No newline at end of file