activitysmith 1.9.0 → 1.11.0

data/README.md

@@ -1,50 +1,35 @@
 # ActivitySmith Ruby SDK
 
-The ActivitySmith Ruby SDK provides convenient access to the ActivitySmith API from Ruby applications.
-
-## Documentation
-
-See [API reference](https://activitysmith.com/docs/api-reference/introduction).
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Setup](#setup)
-- [Push Notifications](#push-notifications)
-  - [Send a Push Notification](#send-a-push-notification)
-  - [Rich Push Notifications with Media](#rich-push-notifications-with-media)
-  - [Actionable Push Notifications](#actionable-push-notifications)
-- [Live Activities](#live-activities)
-  - [Start & Update Live Activity](#start--update-live-activity)
-  - [End Live Activity](#end-live-activity)
-  - [Live Activity Action](#live-activity-action)
-  - [Icons and Badges](#icons-and-badges)
-  - [Live Activity Colors](#live-activity-colors)
-- [Widgets](#widgets)
-- [App Icon Badge Count](#app-icon-badge-count)
-- [Channels](#channels)
+[Documentation](https://activitysmith.com/docs/sdks/ruby)
 
 ## Installation
 
-```sh
+Install the ActivitySmith Ruby SDK with RubyGems:
+
+```bash
 gem install activitysmith
 ```
 
-## Setup
+## Quickstart
+
+1. [Create an API key](https://activitysmith.com/app/keys)
+2. Set `ACTIVITYSMITH_API_KEY` or pass it directly to `ActivitySmith::Client`.
 
 ```ruby
 require "activitysmith"
 
-activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_KEY"))
+activitysmith = ActivitySmith::Client.new(
+  api_key: ENV["ACTIVITYSMITH_API_KEY"]
+)
 ```
 
 ## Push Notifications
 
 ### Send a Push Notification
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/new-subscription-push-notification.png" alt="Push notification example" width="680" />
-</p>
+Send an immediate notification for a completed task or event.
+
+![Push Notification example for a new subscription event](https://cdn.activitysmith.com/features/new-subscription-push-notification.png)
 
 ```ruby
 activitysmith.notifications.send(
@@ -57,26 +42,21 @@ activitysmith.notifications.send(
 
 ### Rich Push Notifications with Media
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-image.png" alt="Rich push notification with image" width="680" />
-</p>
+![Rich Push Notification with image](https://cdn.activitysmith.com/features/rich-push-notification-with-image.png)
 
 ```ruby
 activitysmith.notifications.send(
   {
     title: "Homepage ready",
     message: "Your agent finished the redesign.",
-    media: "https://cdn.example.com/output/homepage-v2.png",
-    redirection: "https://github.com/acme/web/pull/482"
+    media: "https://cdn.example.com/output/homepage-v2.png"
   }
 )
 ```
 
-Send images, videos, or audio with your push notifications, press and hold to preview media directly from the notification, then tap through to open the linked content.
+Attach images, videos, or audio to your Push Notifications. Press and hold the notification to preview the media.
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/rich-push-notification-with-audio.png" alt="Rich push notification with audio" width="680" />
-</p>
+![Rich Push Notification with audio](https://cdn.activitysmith.com/features/rich-push-notification-with-audio.png)
 
 What will work:
 
@@ -85,24 +65,54 @@ What will work:
 - direct video file URL: `.mp4`, `.mov`, etc.
 - URL that responds with a proper media `Content-Type`, even if the path has no extension
 
+`media` cannot be combined with `actions`.
+
+### Push Notifications with Redirection
+
+Open a web page, run an iOS Shortcut, or open an app when someone taps the notification. `redirection` supports:
+
+- **HTTP/HTTPS:** Web pages, e.g. `https://example.com`
+- **Shortcuts:** Run Jarvis with `shortcuts://run-shortcut?name=Jarvis` <!-- full-width -->
+- **App deep links:** Installed apps or specific content within them
+  - **Spotify:** A track, e.g. `spotify:track:6rqhFgbbKwnb9MLmUQDhG6`
+  - **Termius:** `termius://` to open the app
+  - **Claude:** `claude://code` to open the Code tab
+  - **ChatGPT:** `chatgpt://` to open the app <!-- Verify ChatGPT URL scheme on iOS before publishing -->
+
+```ruby
+activitysmith.notifications.send(
+  {
+    title: "Homepage ready",
+    message: "Your agent finished the redesign.",
+    redirection: "https://github.com/acme/web/pull/482"
+  }
+)
+```
+
 ### Actionable Push Notifications
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/actionable-push-notifications-2.png" alt="Actionable push notification example" width="680" />
-</p>
+![Actionable Push Notification with redirection and actions](https://cdn.activitysmith.com/features/actionable-push-notifications-2.png)
 
-Push notification `redirection` and `actions` are optional. Use them to open HTTPS URLs, run a specific iPhone Shortcut with `shortcuts://run-shortcut?name=...`, or trigger backend webhook workflows.
-Webhooks are executed by the ActivitySmith backend.
+`open_url` actions open a web page, run an iOS Shortcut, or open an app when someone taps the button. Supported links:
+
+- **HTTP/HTTPS:** Web pages, e.g. `https://example.com`
+- **Shortcuts:** Run Jarvis with `shortcuts://run-shortcut?name=Jarvis` <!-- full-width -->
+- **App deep links:** Installed apps or specific content within them
+  - **Spotify:** A track, e.g. `spotify:track:6rqhFgbbKwnb9MLmUQDhG6`
+  - **Termius:** `termius://` to open the app
+  - **Claude:** `claude://code` to open the Code tab
+  - **ChatGPT:** `chatgpt://` to open the app <!-- Verify ChatGPT URL scheme on iOS before publishing -->
+
+Webhooks are executed by the ActivitySmith backend and must use HTTPS.
 
 ```ruby
 activitysmith.notifications.send(
   {
     title: "New subscription 💸",
     message: "Customer upgraded to Pro plan",
-    redirection: "https://crm.example.com/customers/cus_9f3a1d", # Optional
-    actions: [ # Optional (max 4)
+    actions: [
       {
-        title: "Open CRM Profile",
+        title: "Open CRM",
         type: "open_url",
         url: "https://crm.example.com/customers/cus_9f3a1d"
       },
@@ -128,14 +138,31 @@ activitysmith.notifications.send(
 
 ## Live Activities
 
-There are six types of Live Activities:
+Choose the Live Activity type that matches what you want to show:
+
+![Stats Live Activity with six labeled sales metrics](https://cdn.activitysmith.com/features/stats-live-activity.png)
+
+**Stats**: Show up to 8 labeled values on your Lock Screen, from revenue and orders to uptime and conversion.
+
+![Metrics Live Activity with CPU and memory values](https://cdn.activitysmith.com/features/metrics-live-activity-start.png)
+
+**Metrics**: Track two related values with segmented bars, such as CPU and memory.
 
-- `stats`: best for showing business numbers side by side, such as revenue, sales, new users, conversion, refunds, or any other value you want visible at a glance
-- `metrics`: best for live percentage values that change often, like server CPU, memory usage, disk usage, or error rate
-- `segmented_progress`: best for anything that moves through clear stages, like deployments, onboarding flows, backups, ETL pipelines, migrations, and AI agent runs
-- `progress`: best for tracking real-time progress with percentage, like tasks, backups, migrations, syncs, or uploads
-- `alert`: best for status updates, such as feature adoption, reactivation, onboarding blockers, incidents, escalations, and other operational states
-- `timer`: best for countdowns and elapsed runtime, like benchmark runs, uploads, backups, transcodes, and long-running jobs
+![Segmented Progress Live Activity showing a workflow step](https://cdn.activitysmith.com/features/update-live-activity.png)
+
+**Segmented Progress**: Show progress through a known set of steps, like build, test, deploy, and verify.
+
+![Progress Live Activity showing percentage completion](https://cdn.activitysmith.com/features/progress-live-activity.png)
+
+**Progress**: Show percentage progress for jobs that move continuously toward completion.
+
+![Alert Live Activity showing a customer reactivation update](https://cdn.activitysmith.com/features/alert-live-activity.png)
+
+**Alert**: Show status updates with a clear message, badge, and icon. When you add an action button, `color` controls the button tint.
+
+![Timer Live Activity showing a benchmark run countdown](https://cdn.activitysmith.com/features/timer-live-activity.png)
+
+**Timer**: Count down from a duration, or count up from 00:00 while a job runs.
 
 ### Start & Update Live Activity
 
@@ -143,13 +170,7 @@ Use a stable `stream_key` to identify the metric, job, deployment, or system you
 
 #### Stats
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/stats-live-activity.png"
-    alt="Stats Live Activity stream example"
-    width="680"
-  />
-</p>
+![Stats Live Activity stream example](https://cdn.activitysmith.com/features/stats-live-activity.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -174,13 +195,7 @@ activitysmith.live_activities.stream(
 
 #### Metrics
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/metrics-live-activity-start.png"
-    alt="Metrics Live Activity stream example"
-    width="680"
-  />
-</p>
+![Metrics Live Activity stream example](https://cdn.activitysmith.com/features/metrics-live-activity-start.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -201,13 +216,7 @@ activitysmith.live_activities.stream(
 
 #### Segmented Progress
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/update-live-activity.png"
-    alt="Segmented Progress Live Activity stream example"
-    width="680"
-  />
-</p>
+![Segmented Progress Live Activity stream example](https://cdn.activitysmith.com/features/update-live-activity.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -226,13 +235,7 @@ activitysmith.live_activities.stream(
 
 #### Progress
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/progress-live-activity.png"
-    alt="Progress Live Activity stream example"
-    width="680"
-  />
-</p>
+![Progress Live Activity stream example](https://cdn.activitysmith.com/features/progress-live-activity.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -250,13 +253,7 @@ activitysmith.live_activities.stream(
 
 #### Alert
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/alert-live-activity.png"
-    alt="Alert Live Activity stream example"
-    width="680"
-  />
-</p>
+![Alert Live Activity stream example](https://cdn.activitysmith.com/features/alert-live-activity.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -275,13 +272,7 @@ activitysmith.live_activities.stream(
 
 #### Timer
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/timer-live-activity.png"
-    alt="Timer Live Activity showing a benchmark run countdown"
-    width="680"
-  />
-</p>
+![Timer Live Activity stream example](https://cdn.activitysmith.com/features/timer-live-activity.png)
 
 ```ruby
 activitysmith.live_activities.stream(
@@ -304,7 +295,7 @@ To start at 00:00 and count up, set `counts_down: false` and leave out `duration
 
 ### End Live Activity
 
-Call `end_stream(...)` with the same `stream_key` to dismiss the Live Activity. You can include final values before it is removed. By default, iOS removes the Live Activity after two minutes. Set `auto_dismiss_minutes` to choose a different dismissal time, including `0` for immediate dismissal.
+Call `end_stream(...)` with the same `stream_key` to dismiss the Live Activity. You can include final values before it is removed. Set `auto_dismiss_seconds` to dismiss it after a delay in seconds, or `auto_dismiss_minutes` for minutes. Use `0` for immediate dismissal. Seconds take precedence if both are set.
 
 ```ruby
 activitysmith.live_activities.end_stream(
@@ -318,30 +309,89 @@ activitysmith.live_activities.end_stream(
         { label: "CPU", value: 7, unit: "%" },
         { label: "MEM", value: 38, unit: "%" }
       ],
-      auto_dismiss_minutes: 2
+      auto_dismiss_seconds: 30
     }
   }
 )
 ```
 
+### Icons and Badges
+
+Add more context to Live Activities with icons and badges.
+
+#### Icon
+
+Supported Live Activity types: `stats`, `metrics`, `progress`, `segmented_progress`, `alert`, and `timer`.
+
+![Metrics Live Activity with an SF Symbol icon on the iPhone Lock Screen](https://cdn.activitysmith.com/features/metrics-live-activity-with-icon.png)
+
+```ruby
+activitysmith.live_activities.stream(
+  "prod-web-1",
+  {
+    content_state: ActivitySmith::LiveActivities.content_state(
+      title: "Server Health",
+      subtitle: "prod-web-1",
+      type: "metrics",
+      icon: ActivitySmith::LiveActivities.alert_icon("server.rack", color: "blue"),
+      metrics: [
+        { label: "CPU", value: 18, unit: "%" },
+        { label: "MEM", value: 42, unit: "%" }
+      ]
+    )
+  }
+)
+```
+
+The `icon` symbol value is an Apple SF Symbol name. Browse the catalog with one of these tools:
+
+- [ActivitySmith app](https://apps.apple.com/us/app/activitysmith/id6752254835) - Open Settings -> SF Symbols to browse 45 hand-picked icons ready to use
+- [SF Symbols](https://developer.apple.com/sf-symbols/) - Apple's official macOS app
+- [Interactful](https://apps.apple.com/app/interactful/id1528095640) - free third-party iOS app listing all SF Symbols under Foundations -> Iconography
+
+#### Badge
+
+Badges are supported by `alert`, `progress`, and `segmented_progress` Live Activities.
+
+![Progress Live Activity with a badge on the iPhone Lock Screen](https://cdn.activitysmith.com/features/progress-live-activity-with-badge.png)
+
+```ruby
+activitysmith.live_activities.stream(
+  "nightly-database-backup",
+  {
+    content_state: ActivitySmith::LiveActivities.content_state(
+      title: "Nightly Database Backup",
+      subtitle: "verify restore",
+      type: "progress",
+      badge: ActivitySmith::LiveActivities.alert_badge("S3", color: "cyan"),
+      percentage: 62
+    )
+  }
+)
+```
+
+### Live Activity Colors
+
+Choose from these colors for the Live Activity accent, including progress bars and action buttons, or apply them to an individual icon or badge:
+
+`lime`, `green`, `cyan`, `blue`, `purple`, `magenta`, `red`, `orange`, `yellow`, `gray`
+
 ### Live Activity Action
 
-Live Activities can include an action button.
+![Metrics Live Activity with action](https://cdn.activitysmith.com/features/metrics-live-activity-action.png)
 
-- `open_url`: open an HTTPS URL.
-- `open_url` with a `shortcuts://` URL: run an Apple Shortcut, for example to open an app.
-- `webhook`: trigger a backend GET/POST workflow.
+Live Activities can include an action button.
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/metrics-live-activity-action.png"
-    alt="Live Activity with action button"
-    width="680"
-  />
-</p>
+- `open_url`: Open a web page or run an iOS Shortcut
+- `webhook`: Trigger a backend GET/POST workflow
 
 #### Open URL action
 
+Open a web page or run an iOS Shortcut when someone taps the button. Supported links:
+
+- **HTTP/HTTPS:** Web pages, e.g. `https://example.com`
+- **Shortcuts:** Run Jarvis with `shortcuts://run-shortcut?name=Jarvis` <!-- full-width -->
+
 ```ruby
 activitysmith.live_activities.stream(
   "prod-web-1",
@@ -358,7 +408,7 @@ activitysmith.live_activities.stream(
     action: {
       title: "Dashboard",
       type: "open_url",
-      url: "https://ops.example.com/servers/prod-web-1"
+      url: "https://status.example.com/servers/prod-web-1"
     }
   }
 )
@@ -368,14 +418,16 @@ activitysmith.live_activities.stream(
 
 ```ruby
 activitysmith.live_activities.stream(
-  "deploy-payments-api",
+  "prod-web-1",
   {
     content_state: {
-      title: "Deploying payments-api",
-      subtitle: "Running database migrations",
-      type: "segmented_progress",
-      number_of_steps: 5,
-      current_step: 3
+      title: "Server Health",
+      subtitle: "prod-web-1",
+      type: "metrics",
+      metrics: [
+        { label: "CPU", value: 76, unit: "%" },
+        { label: "MEM", value: 52, unit: "%" }
+      ]
     },
     action: {
       title: "Chat with Jarvis",
@@ -415,13 +467,7 @@ activitysmith.live_activities.stream(
 
 #### Secondary action
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/live-activity-secondary-action.png"
-    alt="Alert Live Activity with primary and secondary action buttons"
-    width="680"
-  />
-</p>
+![Alert Live Activity with primary and secondary action buttons](https://cdn.activitysmith.com/features/live-activity-secondary-action.png)
 
 Use `secondary_action` when you want a second button beside the primary `action`.
 
@@ -463,126 +509,105 @@ activitysmith.live_activities.stream(
 )
 ```
 
-### Icons and Badges
+## Lock Screen Widgets
 
-Add more context to Live Activities with icons and badges.
+![Lock screen widgets](https://cdn.activitysmith.com/features/lock-screen-widgets.png)
 
-#### Icon
+ActivitySmith lets you display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track. Create a metric in the [web app](https://activitysmith.com/app/widgets), then update the metric value using our API, add a widget to your lock screen and it will fetch the latest update automatically.
 
-Supported Live Activity types: `stats`, `metrics`, `progress`, `segmented_progress`, `alert`, and `timer`.
+![Create widget metric](https://cdn.activitysmith.com/features/create-widget-metric.png)
 
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/metrics-live-activity-with-icon.png"
-    alt="Metrics Live Activity with an SF Symbol icon on the iPhone Lock Screen"
-    width="680"
-  />
-</p>
+Use the metric key to update its value.
 
 ```ruby
-activitysmith.live_activities.stream(
-  "prod-web-1",
-  {
-    content_state: ActivitySmith::LiveActivities.content_state(
-      title: "Server Health",
-      subtitle: "prod-web-1",
-      type: "metrics",
-      icon: ActivitySmith::LiveActivities.alert_icon("server.rack", color: "blue"),
-      metrics: [
-        { label: "CPU", value: 18, unit: "%" },
-        { label: "MEM", value: 42, unit: "%" }
-      ]
-    )
-  }
-)
+activitysmith.metrics.update("deploy.success_rate", 99.9)
 ```
 
-The `icon` symbol value is an Apple SF Symbol name. Browse the catalog with one of these tools:
-
-- [ActivitySmith app](https://apps.apple.com/us/app/activitysmith/id6752254835) - Open Settings -> SF Symbols to browse 45 hand-picked icons ready to use
-- [SF Symbols](https://developer.apple.com/sf-symbols/) - Apple's official macOS app
-- [Interactful](https://apps.apple.com/app/interactful/id1528095640) - free third-party iOS app listing all SF Symbols under Foundations -> Iconography
-
-#### Badge
-
-Badges are supported by `alert`, `progress`, and `segmented_progress` Live Activities.
-
-<p align="center">
-  <img
-    src="https://cdn.activitysmith.com/features/progress-live-activity-with-badge.png"
-    alt="Progress Live Activity with a badge on the iPhone Lock Screen"
-    width="680"
-  />
-</p>
+String metric values work too.
 
 ```ruby
-activitysmith.live_activities.stream(
-  "nightly-database-backup",
-  {
-    content_state: ActivitySmith::LiveActivities.content_state(
-      title: "Nightly Database Backup",
-      subtitle: "verify restore",
-      type: "progress",
-      badge: ActivitySmith::LiveActivities.alert_badge("S3", color: "cyan"),
-      percentage: 62
-    )
-  }
-)
+activitysmith.metrics.update("prod.status", "healthy")
 ```
 
-### Live Activity Colors
+## App Icon Badge Count
 
-Choose from these colors for the Live Activity accent, including progress bars and action buttons, or apply them to an individual icon or badge:
+![ActivitySmith app icon with an App Icon Badge Count](https://cdn.activitysmith.com/features/badge-count.png)
 
-`lime`, `green`, `cyan`, `blue`, `purple`, `magenta`, `red`, `orange`, `yellow`, `gray`
+Show the number you care about on your ActivitySmith app icon. Track MRR, a customer count, a stock price, or any other value you want to keep in view.
 
-## Widgets
+### Set or update the badge value
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/lock-screen-widgets.png" alt="Lock screen widgets" width="680" />
-</p>
+```ruby
+activitysmith.badge_count(8333)
+```
 
-ActivitySmith lets you display any value on your Lock Screen with widgets - SaaS metrics, revenue, signups, uptime, habits, or anything else you want to track. Create a metric in the <a href="https://activitysmith.com/app/widgets" target="_blank" rel="noopener noreferrer">web app</a>, then update the metric value using our API, add a widget to your lock screen and it will fetch the latest update automatically.
+### Clear the badge
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/create-widget-metric.png" alt="Create widget metric" width="680" />
-</p>
+Pass `0` to clear the badge.
 
 ```ruby
-activitysmith.metrics.update("deploy.success_rate", 99.9)
+activitysmith.badge_count(0)
 ```
 
-String metric values work too.
+## Metadata
+
+Metadata adds extra information to Push Notification and Live Activity details in ActivitySmith. It does not appear in the notification or Live Activity on your device.
 
 ```ruby
-activitysmith.metrics.update("prod.status", "healthy")
-```
+activitysmith.notifications.send(
+  title: "New subscription 💸",
+  message: "Customer upgraded to Pro plan",
+  metadata: {
+    customer_id: "382",
+    plan: "Pro",
+    amount: 29,
+    trial: false,
+  }
+)
 
-## App Icon Badge Count
+activitysmith.live_activities.stream(
+  "customer-import",
+  content_state: {
+    title: "Customer Import",
+    type: "progress",
+    percentage: 60,
+  },
+  metadata: {
+    job_id: "import-382",
+    records: 1200,
+  }
+)
+```
 
-<p align="center">
-  <img src="https://cdn.activitysmith.com/features/badge-count.png" alt="ActivitySmith app icon with an App Icon Badge Count" width="680" />
-</p>
+Values can be strings, numbers, or booleans. Metadata supports up to 50 entries and 16 KB of JSON, with keys up to 100 characters and strings up to 4,000 characters. Nested objects, arrays, and null values are not supported.
 
-Show the number you care about on your ActivitySmith app icon. Track MRR, a customer count, a stock price, or any other value you want to keep in view.
+## Tags
 
-Set or update the badge value.
+Use `tags` to organize and filter your Push Notification and Live Activity history. Tags are created automatically when you first use them.
 
 ```ruby
-activitysmith.badge_count(8333)
+activitysmith.notifications.send(
+  {
+    title: "New subscription 💸",
+    message: "Customer upgraded to Pro plan",
+    tags: ["user:382", "billing"]
+  }
+)
 ```
 
-To clear the badge, set its value to 0.
+On Live Activity stream updates and legacy `update` or `end` calls, omit `tags` to keep existing Tags, supply a list to replace them, or pass `tags: []` to clear them.
 
 ```ruby
-activitysmith.badge_count(0)
+activitysmith.live_activities.update(
+  activity_id: "YOUR_ACTIVITY_ID",
+  content_state: { title: "Customer Import", percentage: 60 },
+  tags: []
+)
 ```
 
 ## Channels
 
-Use `channels` to target specific team members or devices
-
-### Push Notifications
+Use `channels` to target specific team members or devices when sending Push Notifications, Live Activities, or App Icon Badge Count updates. Omit it for account-wide delivery.
 
 ```ruby
 activitysmith.notifications.send(
@@ -592,46 +617,39 @@ activitysmith.notifications.send(
     channels: ["sales", "customer-success"]
   }
 )
-```
-
-### Live Activities
 
-```ruby
-activitysmith.live_activities.start(
+activitysmith.live_activities.stream(
+  "nightly-backup",
   {
+    channels: ["ios-builds"],
     content_state: {
-      title: "Nightly Database Backup",
-      subtitle: "verify restore",
-      type: "progress",
-      percentage: 62
-    },
-    channels: ["sales", "customer-success"]
+      title: "Nightly database backup",
+      number_of_steps: 3,
+      current_step: 1,
+      type: "segmented_progress"
+    }
   }
 )
-```
-
-### App Icon Badge Count
 
-```ruby
 activitysmith.badge_count(3, channels: ["sales", "customer-success"])
 ```
 
 ## Error Handling
 
+Handle API errors with `begin/rescue` around SDK calls:
+
 ```ruby
 begin
   activitysmith.notifications.send(
-    { title: "New subscription 💸" }
+    { title: "Hello" }
   )
 rescue OpenapiClient::ApiError => err
   puts "Request failed: #{err.code} #{err.message}"
 end
 ```
 
-## Requirements
-
-- Ruby 3.0+
+## Additional Resources
 
-## License
+### [RubyGems Package](https://rubygems.org/gems/activitysmith)
 
-MIT
+Install the ActivitySmith Ruby SDK from RubyGems