docs: improve README clarity and completeness

- Update the README table formatting to include an additional column separator
- Add documentation for the SSH protocol version option in the README table

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

README.md

@@ -17,12 +17,13 @@ This thing is built using [Golang](https://go.dev) and [drone-ssh](https://githu
 See [action.yml](./action.yml) for more detailed information.
 
 | Input Parameter           | Description                                                                              | Default Value |
-|-------------------------|-----------------------------------------------------------------|---------------|
+|---------------------------|------------------------------------------------------------------------------------------|---------------|
 | host                      | SSH host address                                                                         |               |
 | port                      | SSH port number                                                                          | 22            |
 | passphrase                | SSH key passphrase                                                                       |               |
 | username                  | SSH username                                                                             |               |
 | password                  | SSH password                                                                             |               |
+| protocol                  | SSH protocol version (tcp, tcp4, tcp6)                                                   | tcp           |
 | sync                      | Enable synchronous execution if multiple hosts                                           | false         |
 | use_insecure_cipher       | Include more ciphers with use_insecure_cipher                                            | false         |
 | cipher                    | Allowed cipher algorithms. If unspecified, a sensible default                            |               |
@@ -47,7 +48,7 @@ See [action.yml](./action.yml) for more detailed information.
 | envs                      | Pass environment variables to shell script                                               |               |
 | envs_format               | Flexible configuration of environment value transfer                                     |               |
 | debug                     | Enable debug mode                                                                        | false         |
-| allenvs                 | pass the environment variables with prefix value of GITHUB_ and INPUT_ to the script | false |
+| allenvs                   | pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false         |
 | request_pty               | Request a pseudo-terminal from the server                                                | false         |
 
 ## Usage

entrypoint.sh

@@ -6,6 +6,7 @@ set -o pipefail
 
 export GITHUB="true"
 
+GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}"
 DRONE_SSH_RELEASE_URL="${DRONE_SSH_RELEASE_URL:-https://github.com/appleboy/drone-ssh/releases/download}"
 DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.7.4}"
 
@@ -36,8 +37,6 @@ function detect_client_info() {
   if [ -n "${SSH_CLIENT_ARCH-}" ]; then
     CLIENT_ARCH="${SSH_CLIENT_ARCH}"
   else
-    # TODO: migrate the kube::util::host_platform function out of hack/lib and
-    # use it here.
     local machine
     machine="$(uname -m)"
     case "${machine}" in
@@ -60,7 +59,8 @@ function detect_client_info() {
 detect_client_info
 DOWNLOAD_URL_PREFIX="${DRONE_SSH_RELEASE_URL}/v${DRONE_SSH_VERSION}"
 CLIENT_BINARY="drone-ssh-${DRONE_SSH_VERSION}-${CLIENT_PLATFORM}-${CLIENT_ARCH}"
+TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}"
 echo "Will download ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
-curl -fL --retry 3 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${GITHUB_ACTION_PATH}/drone-ssh
+curl -fL --retry 3 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${TARGET}
-chmod +x ${GITHUB_ACTION_PATH}drone-ssh
+chmod +x ${TARGET}
-sh -c "${GITHUB_ACTION_PATH}/drone-ssh $*"
+sh -c "${TARGET} $*"