From 3d8ccfe0b9bce5222120dbe806d856df934c64f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabi=C3=A1n=20Delgado?= Date: Sat, 8 Oct 2022 13:40:22 -0300 Subject: [PATCH] Update README.md I wasted a lot of time until I found an issue [https://github.com/appleboy/ssh-action/issues/6] that specified this, I added so that it is understandable for users. https://github.com/appleboy/ssh-action/issues/6 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1f7233..01e0173 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ See [action.yml](./action.yml) for more detailed information. * `sync` - synchronous execution if multiple hosts, default is false * `timeout` - timeout for ssh to remote host, default is `30s` * `command_timeout` - timeout for ssh command, default is `10m` -* `key` - content of ssh private key. ex raw content of ~/.ssh/id_rsa +* `key` - content of ssh private key. ex raw content of ~/.ssh/id_rsa, rembemer include the BEGIN and END lines * `key_path` - path of ssh private key * `fingerprint` - fingerprint SHA256 of the host public key, default is to skip verification * `script` - execute commands