From 1737ecaf29869a501f8db81ffa2f3965850da5fc Mon Sep 17 00:00:00 2001
From: Bryan Oltman <bryan@shorebird.dev>
Date: Wed, 17 Apr 2024 10:55:40 -0400
Subject: [PATCH] docs: update readme to include args example

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 28ff28a..16e6489 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,8 @@ Create a new release using the [Shorebird CLI](https://github.com/shorebirdtech/
 
 ## Usage
 
+Standard usage:
+
 ```yaml
 steps:
   - uses: shorebirdtech/setup-shorebird@v0
@@ -28,6 +30,19 @@ steps:
     shell: bash
 ```
 
+If you need to provide arguments to the release command, you can do so like this:
+
+```yaml
+steps:
+  - uses: shorebirdtech/setup-shorebird@v0
+  - uses: shorebirdtech/shorebird-release@v0
+    id: shorebird-release
+    with:
+      args: --flutter-version=1.2.3 --verbose --flavor=my-flavor --target=lib/special_main.dart
+      platform: android
+      working-directory: ./path/to/app
+```
+
 ## Inputs
 
 The action takes the following inputs: