From bcb314ec07ac44451e876a5a0a93c1b68645dca7 Mon Sep 17 00:00:00 2001
From: shimataro <info@shimataro.me>
Date: Mon, 31 Oct 2022 00:31:19 +0900
Subject: [PATCH] fix usage of rsync (#218)

---
 CHANGELOG.md | 4 ++++
 README.md    | 6 +++---
 2 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5eec312..869269a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Fixed
+
+* usage of `rsync` in README
+
 ### Others
 
 * add `windows-2022`, and `macos-11` (thanks [@ViacheslavKudinov](https://github.com/ViacheslavKudinov))
diff --git a/README.md b/README.md
index f249ed9..e811cf8 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,8 @@ steps:
     known_hosts: ${{ secrets.KNOWN_HOSTS }}
     config: ${{ secrets.CONFIG }} # ssh_config; optional
     if_key_exists: fail # replace / ignore / fail; optional (defaults to fail)
-- name: rsync over ssh
-  run: rsync ./foo/ user@remote:bar/
+- name: rsync over SSH
+  run: rsync -r ./foo/ user@remote:bar/
 ```
 
 See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/workflow-syntax-for-github-actions) for details.
@@ -114,7 +114,7 @@ Here are some solutions:
 I recommend **rsync via bastion**.
 
 ```bash
-rsync -e "ssh bastion ssh" ./foo/ target:bar/
+rsync -r -e "ssh bastion ssh" ./foo/ target:bar/
 ```
 
 It has some advantages over other methods: