From 3b0cbbe3356f8e8b8125206cacb9939f2ef1225c Mon Sep 17 00:00:00 2001
From: "@zimeg" <zim@o526.net>
Date: Sun, 27 Oct 2024 17:08:22 -0700
Subject: [PATCH] docs: write notes on strategies for retrying failed requests

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

diff --git a/README.md b/README.md
index 44f3347..b926836 100644
--- a/README.md
+++ b/README.md
@@ -405,7 +405,32 @@ technique, but configuring a proxy works the same way for all of them:
     token: ${{ secrets.SLACK_BOT_TOKEN }}
     payload: |
       channel: ${{ secrets.SLACK_CHANNEL_ID }}
-      message: "This message was sent through a proxy"
+      text: "This message was sent through a proxy"
+```
+
+### Retrying failed requests
+
+Sometimes outgoing requests fail due to [rate limits][rate-limits] or similar
+[HTTP responses][retry-after] and can be retried later.
+
+The `retries` option can be configured to the needs of your workflow with one
+of these values:
+
+- `0`: No retries, just hope that things go alright.
+- `5`: Five retries in five minutes. **Default**.
+- `10`: Ten retries in about thirty minutes.
+- `RAPID`: A burst of retries to keep things running fast.
+
+```yaml
+- name: Attempt a burst of requests
+  uses: slackapi/slack-github-action@v2-development
+  with:
+    method: chat.postMessage
+    retries: RAPID
+    token: ${{ secrets.SLACK_BOT_TOKEN }}
+    payload: |
+      channel: ${{ secrets.SLACK_CHANNEL_ID }}
+      text: "status: all things are going good"
 ```
 
 ## License