From 575fdd286ccc1a496b23b1f94423cfebee6190d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rados=C5=82aw=20Kukuczka?= <grandfso+gitlab@gmail.com>
Date: Sun, 30 Mar 2025 13:24:23 +0200
Subject: [PATCH] update readme

---
 README.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 114 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4ab68a5 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,114 @@
+# 🚀 Deploy to Docker (Swarm or Compose) Action
+
+Robustly deploy your Docker Compose files to Docker Swarm or regular Docker Compose environments via SSH. This action provides detailed debug output, secure SSH handling, validation, and automatic cleanup for a smooth, reliable deployment experience.
+
+---
+
+## ✨ Features
+
+- ✅ **Supports both Docker Swarm and Docker Compose**
+- 🔑 **Secure SSH key handling**
+- 🔍 **Remote validation of Docker Compose files**
+- 🧹 **Automatic cleanup of temporary files**
+- 📋 **Detailed debug logs for easy troubleshooting**
+
+---
+
+## 📥 Inputs
+
+| Input              | Description                                      | Required | Default |
+|--------------------|--------------------------------------------------|----------|---------|
+| `stack_name`       | Docker stack or compose project name             | ✅ Yes    | -       |
+| `ssh_host`         | SSH host                                         | ✅ Yes    | -       |
+| `ssh_user`         | SSH username                                     | ✅ Yes    | -       |
+| `ssh_key`          | SSH private key                                  | ✅ Yes    | -       |
+| `deploy_file`      | Path to the processed deployment file            | ✅ Yes    | -       |
+| `deploy_mode`      | Deployment mode: `swarm` or `compose`            | ❌ No     | `swarm` |
+| `remote_temp_dir`  | Remote temporary directory for deployment files  | ❌ No     | `/tmp`  |
+
+---
+
+## 🚦 Deployment Modes
+
+This action supports two deployment modes:
+
+- **Docker Swarm (`swarm`)** 🚢  
+  Deploys using `docker stack deploy`.
+
+- **Docker Compose (`compose`)** 🐳  
+  Deploys using `docker compose up`.
+
+---
+
+## 🛠️ Example Usage
+
+### Deploying to Docker Swarm 🚢
+
+```yaml
+- name: Deploy to Docker Swarm 🚢
+  uses: your-org/deploy-to-docker-action@main
+  with:
+    stack_name: my-awesome-stack
+    ssh_host: ${{ vars.SSH_HOST }}
+    ssh_user: ${{ secrets.SSH_USER }}
+    ssh_key: ${{ secrets.SSH_KEY }}
+    deploy_file: docker-compose.processed.yml
+    deploy_mode: swarm
+```
+
+### Deploying with Docker Compose 🐳
+
+```yaml
+- name: Deploy using Docker Compose 🐳
+  uses: your-org/deploy-to-docker-action@main
+  with:
+    stack_name: my-compose-project
+    ssh_host: ${{ vars.SSH_HOST }}
+    ssh_user: ${{ secrets.SSH_USER }}
+    ssh_key: ${{ secrets.SSH_KEY }}
+    deploy_file: docker-compose.processed.yml
+    deploy_mode: compose
+```
+
+---
+
+## 🧑‍💻 How It Works
+
+This action performs the following steps:
+
+1. 🔑 **Securely creates a temporary SSH key file** for authentication.
+2. 📁 **Creates a secure temporary directory** on the remote host.
+3. 📤 **Copies your processed Docker Compose file** to the remote host.
+4. 🔍 **Validates the Docker Compose file remotely** to ensure correctness.
+5. 🚢🐳 **Deploys your stack/project** based on the selected deployment mode.
+6. 🧹 **Cleans up temporary files** both locally and remotely.
+
+---
+
+## 📖 Debugging & Logs
+
+During deployment, the action provides detailed debug logs at every step, making it easy to troubleshoot any issues:
+
+- ✅ SSH connection details
+- ✅ File transfer status
+- ✅ Validation results
+- ✅ Deployment status
+- ✅ Cleanup confirmation
+
+---
+
+## ⚠️ Requirements
+
+- SSH access to your Docker host.
+- Docker & Docker Compose installed on the remote host.
+- Proper permissions to deploy stacks or compose projects remotely.
+
+---
+
+## 📜 License
+
+This action is open-source software licensed under the MIT license.
+
+---
+
+🎉 **Happy Deploying!** 🎉
\ No newline at end of file