From d8c2e0694316f87beb56ea824b2b993daef1e1d9 Mon Sep 17 00:00:00 2001
From: Braxton Beyer <braxton@braxtonbeyer.com>
Date: Wed, 22 Jan 2020 21:25:09 -0500
Subject: [PATCH] adding comments to readme

adding more comments to readme to better explain how this works.
---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index 1de1fa6..274d5cb 100644
--- 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
 ```