From 64b708adcad66f1a25a7ccb00684c4e378074df6 Mon Sep 17 00:00:00 2001
From: jank <jan@kjan.email>
Date: Sun, 1 Jun 2025 15:45:17 +0200
Subject: [PATCH] fix: Add Readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6baf059
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+## Docker build
+
+### Description
+
+Builds a docker image
+
+### Inputs
+
+| name | description | required | default |
+| --- | --- | --- | --- |
+| `name` | <p>Directory name</p> | `true` | `""` |
+| `REGISTRY_USERNAME` | <p>Registry username</p> | `true` | `""` |
+| `REGISTRY_TOKEN` | <p>Registry token</p> | `true` | `""` |
+| `DOCKER_USERNAME` | <p>Docker username</p> | `true` | `""` |
+| `DOCKER_PASSWORD` | <p>Docker password</p> | `true` | `""` |
+
+
+### Runs
+
+This action is a `composite` action.
+
+### Usage
+
+```yaml
+- uses: ***PROJECT***@***VERSION***
+  with:
+    name:
+    # Directory name
+    #
+    # Required: true
+    # Default: ""
+
+    REGISTRY_USERNAME:
+    # Registry username
+    #
+    # Required: true
+    # Default: ""
+
+    REGISTRY_TOKEN:
+    # Registry token
+    #
+    # Required: true
+    # Default: ""
+
+    DOCKER_USERNAME:
+    # Docker username
+    #
+    # Required: true
+    # Default: ""
+
+    DOCKER_PASSWORD:
+    # Docker password
+    #
+    # Required: true
+    # Default: ""
+```
+
+
+