adding comments to readme

adding more comments to readme to better explain how this works.
2020-01-22 21:25:09 -05:00 · 2020-01-22 21:25:09 -05:00 · d8c2e06943
parent 02dd1e4a56
commit d8c2e06943
1 changed files with 3 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -19,6 +19,9 @@ steps:

 - uses: actions/upload-artifact@v1
  with:
+    # A directory will be created with this name and populated with the items in the path below.
+    # Then it will be compressed into a zip file.
+    # if you later use download-artifact, this zip file will be downloaded and automatically expanded.
    name: my-artifact
    path: path/to/artifact
 ```