From b06f5dd033e6fc02256f06a6cc1208ed7a087503 Mon Sep 17 00:00:00 2001 From: Martin Bjeldbak Madsen Date: Tue, 11 Feb 2020 13:56:13 +1000 Subject: [PATCH] Improve example usage --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ab30398..513affb 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,15 @@ Inspired by the following actions ## Example usage +Be sure to run the [`actions/checkout`](https://github.com/actions/checkout) action in a step before +this action so that the git repository exists. + +```yaml uses: netengine/github-repository-sync-action with: - who-to-greet: 'Mona the Octocat' + ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} + target_repo_url: git@github.com:net-engine/github-repository-sync-action-test.git +``` ## TODO