From 4cf3280bb8206af2d19651ba34534806f993b1a9 Mon Sep 17 00:00:00 2001
From: Ryosuke Ito <rito.0305@gmail.com>
Date: Wed, 28 Aug 2024 21:56:42 +0900
Subject: [PATCH] Add description of build_args

---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 30deca7..a34c5c5 100644
--- a/README.md
+++ b/README.md
@@ -36,12 +36,15 @@ periphery.binary_path = "bin/periphery"
 You can pass command line options to `periphery.scan` like the following.
 See `periphery scan -h` for available options.
 
+Note that `build_args` option is a special option that does not exist in Periphery but the arguments are passed down to `periphery` after an argument terminator (`--`).
+
 ```ruby
 periphery.scan(
   project: "Foo.xcodeproj",
   schemes: ["foo", "bar"],
   targets: "foo",
-  clean_build: true
+  clean_build: true,
+  build_args: "-sdk iphonesimulator"
 )
 ```