Skip to content

Commit

Permalink
Updated readme with information about the new Info.plist keys
Browse files Browse the repository at this point in the history
  • Loading branch information
insidegui committed Sep 30, 2020
1 parent f85feb8 commit 0fabe19
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Check the example folder for a sample implementation.

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

## Info.plist configuration

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.

The keys are `Privacy - Local Network Usage Description` (`NSLocalNetworkUsageDescription`) and `Bonjour services` (`NSBonjourServices`).

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.

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`.

**If you do not configure the above keys properly, then MultipeerKit won't work.**

## Usage

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

0 comments on commit 0fabe19

Please sign in to comment.