note on configuring detox with Xcode workspaces (#300)

wix · Sep 29, 2017 · 5fac6ed · 5fac6ed
1 parent a1ca6c3
commit 5fac6ed
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/Introduction.GettingStarted.md b/docs/Introduction.GettingStarted.md
@@ -96,6 +96,8 @@ The basic configuration for Detox should be in your `package.json` file under th
 
 In the above configuration example, change `example` to your actual project name. Under the key `"binaryPath"`, `example.app` should be `<your_project_name>.app`. Under the key `"build"`, `example.xcodeproj` should be `<your_project_name>.xcodeproj` and `-scheme example` should be `-scheme <your_project_name>`.
 
+For iOS apps in a workspace (eg: Cocoapods) use `-workspace ios/example.xcworkspace` instead of `-project`.
+
 Also make sure the simulator model specified under the key `"name"` (`iPhone 7` above) is actually available on your machine (it was installed by Xcode). Check this by typing `xcrun simctl list` in terminal to display all available simulators.
 
 > TIP: To test a release version, replace 'Debug' with 'Release' in the binaryPath and build properties. For full configuration options see Configuration under the API Reference.