From 001981184657626bd3e80416096b9a24d48f05e5 Mon Sep 17 00:00:00 2001
From: Nick Fields <nickfields@invisionapp.com>
Date: Thu, 23 Sep 2021 22:36:47 -0400
Subject: [PATCH] docs: update README with new input and usage

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 37280da..0486a81 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,10 @@ Retries an Action step on failure or timeout. This is currently intended to repl
 
 **Optional** Command to run before a retry (such as a cleanup script). Any error thrown from retry command is caught and surfaced as a warning.
 
+### `continue_on_error`
+
+**Optional** Exit successfully even if an error occurs. Same as native continue-on-error behavior, but for use in composite actions. Defaults to `false`
+
 ## Outputs
 
 ### `total_attempts`
@@ -113,7 +117,29 @@ with:
   command: npm run some-typically-fast-script
 ```
 
-### Retry but allow failure and do something with output
+### Retry using continue_on_error input (in composite action) but allow failure and do something with output
+
+```yaml
+- uses: nick-invision/retry@v2
+  id: retry
+  with:
+    timeout_seconds: 15
+    max_attempts: 3
+    continue-on-error: true
+    command: node -e 'process.exit(99);'
+- name: Assert that step succeeded (despite failing command)
+  uses: nick-invision/assert-action@v1
+  with:
+    expected: success
+    actual: ${{ steps.retry.outcome }}
+- name: Assert that action exited with expected exit code
+  uses: nick-invision/assert-action@v1
+  with:
+    expected: 99
+    actual: ${{ steps.retry.outputs.exit_code }}
+```
+
+### Retry using continue-on-error built-in command (in workflow action) but allow failure and do something with output
 
 ```yaml
 - uses: nick-invision/retry@v2