Skip to content

Commit

Permalink
Add Migration Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
ssikira committed Nov 8, 2018
1 parent cb2f6d0 commit ca66f0c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Migration Guide/iZettle SDK 2.0 Migration Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# iZettle SDK v2.0 migration guide

iZettle SDK 2.0 is latest major release containing support for iZettle Reader 2. This guide is provided in order to ease the transition of existing applications using iZettle SDK 1.0+ to the latest release.

## Linking with new framework

iZettle SDK v2.0 introduces a new `iZettleTransport` framework. This framework needs to be linked along current frameworks (`iZettleSDK`, `iZettleShared`, and `iZettlePayments`) in order to work. More info on installation can be found [here](https://github.com/iZettle/sdk-ios#installation).

## Using BLE technology in background modes

The new iZettle Reader 2 uses BLE technology to communicate with the SDK. To make sure that apps using SDK can communicate and work with the new readers in background, you need to enable **Use BLE accessories** in Background Modes in Xcode capabilities.

You can also do this step manually, and make the change directly in your apps `Info.plist` file. The `UIBackgroundModes` values should look like this:

```
<key>UIBackgroundModes</key>
<array>
<string>bluetooth-central</string>
<string>external-accessory</string>
</array>
```

0 comments on commit ca66f0c

Please sign in to comment.