From f17dfd3443d52d6e716fe184b91d46646738cdb7 Mon Sep 17 00:00:00 2001 From: Danny McCormick Date: Tue, 23 Jul 2019 15:24:56 -0400 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 162aa6d..f431a30 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ # upload-artifact + +This uploads artifacts from your build. + +# Usage + +See [action.yml](action.yml) + +Basic (upload current working directory): +```yaml +actions: +- uses: actions/checkout@latest + +# Do stuff + +- uses: actions/upload-artifact@latest + with: + name: my-artifact +``` + +Upload specific directory: +```yaml +actions: +- uses: actions/checkout@latest + +- run: mkdir -p path/to/artifact + +- run: echo hello > path/to/artifact/world.txt + +- uses: actions/upload-artifact@latest + with: + name: my-artifact + path: path/to/artifact +``` + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE)