From 02dd1e4a56ccec4d066fe5ad9e92ba6d31b0e2fe Mon Sep 17 00:00:00 2001
From: Braxton Beyer <braxton@braxtonbeyer.com>
Date: Wed, 22 Jan 2020 21:20:58 -0500
Subject: [PATCH] add more comments

add more comments to help explain how this action actually works and what it does under the hood. This is not documented anywhere else
---
 action.yml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/action.yml b/action.yml
index 2876ff8..16adf85 100644
--- a/action.yml
+++ b/action.yml
@@ -1,13 +1,18 @@
 name: 'Upload a Build Artifact'
 description: 'Upload a build artifact that can be used by subsequent workflow steps'
 author: 'GitHub'
-inputs: 
+inputs:
+ 
+  # 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.
   name:
     description: 'Artifact name'
     required: true
+  
   path:
     description: 'Directory containing files to upload'
     required: true
+
 runs:
   # Plugins live on the runner and are only available to a certain set of first party actions.
   plugin: 'publish'