From 0d608f8ef76d25976130a63cbe7f8db3945189e2 Mon Sep 17 00:00:00 2001
From: Carles Pina i Estany <carles@pina.cat>
Date: Wed, 21 Sep 2022 17:25:43 +0100
Subject: [PATCH] Add documentation for the composite version

---
 action.yml | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/action.yml b/action.yml
index 9f8d572..adb48b6 100644
--- a/action.yml
+++ b/action.yml
@@ -52,8 +52,13 @@ inputs:
 runs:
   using: composite
   steps:
-    - run: apt-get update && apt-get install -y openssh-client git
-      shell: sh
+    # You openssh-client is needed if ssh-deploy keys are used
+    # (to fetch the fingerprints of the server)
+    # git is needed to pull/push
+    # Probably this is already installed in your machine, otherwise
+    # install it using the line below or adding sudo
+    #- run: apt-get update && apt-get install -y openssh-client git
+    # shell: sh
     - run: $GITHUB_ACTION_PATH/entrypoint.sh "${{ inputs.source-before-directory }}" "${{ inputs.source-directory }}" "${{ inputs.destination-github-username }}" "${{ inputs.destination-repository-name }}" "${{ inputs.github-server }}" "${{ inputs.user-email }}" "${{ inputs.user-name }}" "${{ inputs.destination-repository-username }}" "${{ inputs.target-branch }}" "${{ inputs.commit-message }}" "${{ inputs.target-directory }}"
       shell: sh
 branding: