update readme example

README.md

@@ -13,7 +13,7 @@ gem "fastlane-plugin-qawolf", git: "https://github.com/qawolf/fastlane-plugin-qa
 
 Fastlane plugin for QA Wolf integration.
 
-Uploads build artifacts (IPA, APK, or AAB) to QA Wolf storage for automated testing.
+Uploads build artifacts (IPA, APK, or AAB) to QA Wolf storage for automated testing. Optionally triggers a test run on QA Wolf.
 
 > [!IMPORTANT]
 > Testing iOS apps (IPA) on QA Wolf is not yet available.
@@ -24,17 +24,39 @@ Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plu
 
 ```ruby
 lane :build do
-  # option 1: rely on env vars and output from other lanes
-  # QAWOLF_API_KEY must be set in the environment
-  # expects `gradle` to have set the APK (or AAB) output path
+  # Step 1: Build your app
+  # Ensure the APK/AAB file has been created. Your use case may vary.
   gradle
-  qawolf # alias for upload_to_qawolf
 
-  # option 2: pass in the values directly
+  # Step 2: Upload the artifact to QA Wolf
   upload_to_qawolf(
+    # Must be set or available as env var QAWOLF_API_KEY
     qawolf_api_key: "qawolf_...",
-    file_path: "./build/app-bundle.apk",
-    filename: "app.apk"
+
+    # only set this if you have not built the artifact in the same lane
+    # e.g. via gradle or similar, check official Fastlane docs for details
+    file_path: "./build/app-bundle.apk"
+  )
+
+  # Step 3: Trigger a test run on QA Wolf
+  # optional, only use when deployment triggers are enabled in QA Wolf
+  notify_deploy_qawolf(
+    # Must be set or available as env var QAWOLF_API_KEY
+    qawolf_api_key: "qawolf_...",
+
+    # These fields are dependent on how triggers are setup within QA Wolf.
+    # Reach out to support for help. All fields are optional.
+    branch: nil,
+    commit_url: nil,
+    deduplication_key: nil,
+    deployment_type: nil,
+    deployment_url: nil,
+    hosting_service: nil,
+    sha: nil,
+    variables: nil,
+
+    # Only set this if your lane does not include `upload_to_qawolf`
+    run_input_path: nil,
   )
 end
 ```