From 24f65477e79fc6527b6902e5da180ac093892877 Mon Sep 17 00:00:00 2001 From: isbang Date: Sat, 28 Nov 2020 02:31:53 +0900 Subject: [PATCH] docs: update README example usage write more clear and specify that needs actions/checkout ref #1 --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 453116c..311ff4b 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ This action runs your docker-compose file and clean up before action finished. ## Example usage -uses: isbang/compose-action@v0.1 -with: - compose-file: './docker-compose.yml' +```yaml +steps: + # need checkout before using compose-action + - uses: actions/checkout@v2 + - uses: isbang/compose-action@v0.1 + with: + compose-file: './docker/docker-compose.yml' +``` \ No newline at end of file