From 062b83e7bf2bc2913ecf0d3cf2463d73c5dcca52 Mon Sep 17 00:00:00 2001 From: Danny McCormick Date: Tue, 23 Jul 2019 15:28:49 -0400 Subject: [PATCH] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 2a6b9dd..4cb6bd0 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ # download-artifact + +This downloads artifacts from your build. + +# Usage + +See [action.yml](action.yml) + +Basic (upload current working directory): +```yaml +actions: +- uses: actions/checkout@latest + +- uses: actions/download-artifact@latest + with: + name: my-artifact + +- run: cat my-artifact +``` + +Download to specific directory: +```yaml + +actions: +- uses: actions/checkout@latest + +- uses: actions/download-artifact@latest + with: + name: my-artifact + path: path/to/artifact + +- run: cat path/to/artifact/my-artifact +``` + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE)