From 47b7a7bd4ef154e7697f833ec7f39f7edcfa6f29 Mon Sep 17 00:00:00 2001
From: Denis Nikiforov <wirgen@users.noreply.github.com>
Date: Fri, 9 Dec 2022 00:16:33 +0300
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5b7ec7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Portainer stack redeploy action
+
+This action allows you to update the stack with pull new images if you can't use webhooks. For example, in Portainer Community Edition.
+
+## Inputs
+
+### `portainerUrl`
+
+**Required** URL to the application instance. For example, https://example.com:9443
+
+### `accessToken`
+
+**Required** Token for API requests, can be created on the page https://example.com:9443/#!/account/tokens/new
+
+### `stackId`
+
+**Required** ID of stack to be updated. Must be integer
+
+### `endpointId`
+
+ID of endpoint (environment). Required if your stack is not in local environment
+
+## Example usage
+
+```yaml
+uses:  wirgen/portainer-stack-redeploy-action@v1
+with:
+  portainerUrl: 'https://example.com:9443'
+  accessToken: 'ptr_XXXyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+  stackId: 8
+  endpointId: 3
+```