From 3185559903402af7a82a64a52f5a8c18393561ae Mon Sep 17 00:00:00 2001 From: momoein Date: Sat, 19 Jul 2025 13:38:51 +0330 Subject: [PATCH 1/2] docs: update readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ee61c7..26de382 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,17 @@ SMTP_USERNAME=example@gmail.com SMTP_PASSWORD=aaaabbbbccccdddd ``` -2. Build the Docker image: +2. Pull the Docker image: ```bash +docker pull ghcr.io/cactusbros/smaila:latest # or specific version like v0.2.2 +``` + +Or manually Build the image: + +```bash +git clone https://github.com/CactusBros/smaila.git +cd smaila docker build -t smaila . ``` From e19aad24beea5973c19cff2ddf16c6cca69934db Mon Sep 17 00:00:00 2001 From: momoein Date: Sat, 19 Jul 2025 13:55:45 +0330 Subject: [PATCH 2/2] docs: update readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 26de382..8ad34a8 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,21 @@ docker build -t smaila . 3. Run the container: +```bash +docker run -p 8080:8080 --env-file .env ghcr.io/cactusbros/smaila:latest # or specific version like v0.2.2 +``` + +Or using the manually built image: + ```bash docker run -p 8080:8080 --env-file .env smaila ``` +> 💡 **Note**: If your `.env` file is not in the current directory, provide the full path to it using the `--env-file` flag, like: +> ```bash +> docker run -p 8080:8080 --env-file /path/to/.env smaila +> ``` + ## 📘 API Documentation After running the container, access the interactive API docs at: