From b2946c375bdced4c61e2e021e810b799e1b08506 Mon Sep 17 00:00:00 2001 From: Dawid Dziurla Date: Sun, 22 Mar 2020 13:01:58 +0100 Subject: [PATCH] README: update --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ebb1b9d..5ea5866 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # Run Ansible playbook Github Action +An action that executes given Ansible playbook on selected hosts. + +## Usage + +```yaml +- name: Run playbook + uses: dawidd6/action-ansible-playbook + with: + playbook: deploy.yml + key: ${{secrets.SSH_PRIVATE_KEY}} + options: | + --inventory hosts + --limit dev + --extra-vars hello=there + --verbose +```