From 5f9d0d8d7140011b1de4f756202d97addbe178b9 Mon Sep 17 00:00:00 2001 From: bardonadam Date: Sat, 10 Oct 2026 08:41:42 +0700 Subject: [PATCH] Warn about the iOS Live Activity update budget Add the update budget callout to the Live Activity stream section and sync the custom icon wording from the SDK docs. Co-Authored-By: Claude Opus 5.5 --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ab1cf50..89d25f0 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ activitysmith.notifications.send( ![Push Notifications with custom icons](https://cdn.activitysmith.com/features/push-notifications-with-custom-icons.png) -Set `icon` to a publicly accessible HTTPS image URL to show an avatar or service logo alongside a smaller ActivitySmith app icon. With a custom icon, iOS may omit the subtitle from the notification. +Set `icon` to a publicly accessible HTTPS image URL to show a logo or avatar alongside a smaller ActivitySmith app icon. With a custom icon, iOS may omit the subtitle from the notification. ```python activitysmith.notifications.send( @@ -232,6 +232,9 @@ Choose the Live Activity type that matches what you want to show: Use a stable `stream_key` to identify the metric, job, deployment, or system you want to keep visible. The first `stream(...)` call starts the Live Activity. Later calls with the same `stream_key` update it. +> [!WARNING] +> iOS limits how often a Live Activity can update. If you send too many updates, iOS throttles them until the budget refills, which takes roughly an hour, even though the API still returns `200`. Send one or two updates every five minutes. [Learn more](https://activitysmith.com/docs/live-activity-stream#update-frequency-and-ios-limits) + #### Value ![Value Live Activity stream example](https://cdn.activitysmith.com/features/value-live-activity.png)