Skip to content

Commit 0fabe19

Browse files
committed
Updated readme with information about the new Info.plist keys
1 parent f85feb8 commit 0fabe19

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ Check the example folder for a sample implementation.
88

99
![Sample](../assets/demo.gif?raw=true)
1010

11+
## Info.plist configuration
12+
13+
In order for MultipeerKit to work when running on iOS 14, you will have to include two keys in your app's Info.plist file.
14+
15+
The keys are `Privacy - Local Network Usage Description` (`NSLocalNetworkUsageDescription`) and `Bonjour services` (`NSBonjourServices`).
16+
17+
For the privacy key, include a human-readable description of what benefit the user gets by allowing your app to access devices on the local network.
18+
19+
The Bonjour services key is an array of service types that your app will browse for. For MultipeerKit, the entry should be in the format `_servicename._tcp`, where `servicename` is the `serviceType` you've set in your `MultipeerConfiguration`. If you're using the default configuration, the value of this key should be `_MKSVC._tcp`.
20+
21+
**If you do not configure the above keys properly, then MultipeerKit won't work.**
22+
1123
## Usage
1224

1325
The main class in this library is `MultipeerTransceiver`, which does both the sending and receiving aspects of the multipeer communication.

0 commit comments

Comments
 (0)