update readme

actions · Jan 18, 2024 · 40b3052 · 40b3052
1 parent 49552fc
commit 40b3052
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -93,6 +93,12 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
     # For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
     # Optional. Default is '6'
     compression-level:
+
+    # If true, an artifact with a matching name will be deleted before a new one is uploaded.
+    # If false, the action will fail if an artifact for the given name already exists.
+    # Does not fail if the artifact does not exist.
+    # Optional. Default is 'false'
+    overwrite:
 ```
 
 ### Outputs

diff --git a/action.yml b/action.yml
@@ -36,7 +36,7 @@ inputs:
     default: '6'
   overwrite:
     description: >
-      If true, an artifact matching name will be deleted before a new one is uploaded.
+      If true, an artifact with a matching name will be deleted before a new one is uploaded.
       If false, the action will fail if an artifact for the given name already exists.
       Does not fail if the artifact does not exist.
     default: 'false'