From 18120ada8b44855ff6b59cef0cdc6e7ec8ab7430 Mon Sep 17 00:00:00 2001
From: Shihaam Abdul Rahman <shihaam@shihaam.me>
Date: Sat, 21 Sep 2024 02:52:59 +0500
Subject: [PATCH] add documentation

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8db4f76
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## SMTP to Telegram
+
+## Deploy
+1. Create `compose.yml`
+```yml
+services:
+  smtp-to-telegram:
+    image: git.shihaam.dev/shihaam/smtp-to-telegram
+    restart: always
+    env_file: .env
+    ports:
+      - 2525:2525
+```
+2. Fill .env
+```
+TELEGRAM_API_KEY=
+TELEGRAM_CHAT_ID=
+```
+3. Start the container `docker compose up -d`
+
+
+