From 677df92bbae826124b602d05a5c2eec03d0d56a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Carlos=20Mej=C3=ADas=20Rodr=C3=ADguez?= Date: Sat, 24 Nov 2018 20:51:16 -0500 Subject: [PATCH] Update docs for ACTION and -a in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c0980c8..bc9fb04 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The provided `psu` script allows to deploy/update/undeploy portainer stacks. Set This is particularly useful for CI/CD pipelines. -- `ACTION` (string, required): deploy/undeploy +- `ACTION` ("deploy" or "undeploy", required): Whether to deploy or undeploy the stack - `PORTAINER_USER` (string, required): Username - `PORTAINER_PASSWORD` (string, required): Password - `PORTAINER_URL` (string, required): URL to Portainer @@ -63,7 +63,7 @@ export PORTAINER_STACK_NAME="mystack" This is more suitable for standalone script usage. -- `-a` (string, required): deploy/undeploy +- `-a` ("deploy" or "undeploy", required): Whether to deploy or undeploy the stack - `-u` (string, required): Username - `-p` (string, required): Password - `-l` (string, required): URL to Portainer