README: update

dawidd6 · Mar 22, 2020 · b2946c3 · b2946c3
1 parent 11bc420
commit b2946c3
Showing 1 changed file with 16 additions and 0 deletions.
diff --git 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
+```