diff --git a/connections/swift/NearbyConnections/Example/README.md b/connections/swift/NearbyConnections/Example/README.md new file mode 100644 index 00000000..cbc3da48 --- /dev/null +++ b/connections/swift/NearbyConnections/Example/README.md @@ -0,0 +1,27 @@ +# Nearby Connections iOS Example + +A sample app for using Nearby Connections in iOS. + +## Setup +1. Clone the Nearby repo with all submodules by running the following command: + + ```bash + git clone --recurse-submodules https://github.com/google/nearby.git + ``` + +2. Open the sample app in Xcode: + + ```bash + open nearby/connections/swift/NearbyConnections/Example/iOS\ Example.xcodeproj + ``` + +3. Choose a development team by navigating to `iOS Example` > `iOS Example` under "Targets" > `Signing & Capabilities` and then choosing your team from the "team" drop-down: + + ![development team](../Resources/development-team.png) + + +## Run the App + +The app can be run pressing the "run" button or the Command + R keyboard shortcut: + +![run](../Resources/run.png) diff --git a/connections/swift/NearbyConnections/Resources/development-team.png b/connections/swift/NearbyConnections/Resources/development-team.png new file mode 100644 index 00000000..140eeab8 Binary files /dev/null and b/connections/swift/NearbyConnections/Resources/development-team.png differ diff --git a/connections/swift/NearbyConnections/Resources/run.png b/connections/swift/NearbyConnections/Resources/run.png new file mode 100644 index 00000000..1a0d2306 Binary files /dev/null and b/connections/swift/NearbyConnections/Resources/run.png differ