You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repo contains the Electric Imp BlinkUp™ SDK for iOS as it is made available to Electric Imp customers. It mirrors the downloadable files hosted by the [Dev Center](https://developer.electricimp.com/manufacturing/sdkdocs), but in a form that allows developers to add the SDK to their app project repos as a sub-module. This will allow them to pull in SDK changes manually at build time, or automatically through their own build scripts.
3
+
This repo contains the Electric Imp BlinkUp™ SDK for iOS as it is made available to Electric Imp customers. It mirrors the downloadable files hosted by the [Dev Center](https://developer.electricimp.com/manufacturing/sdkdocs), but in a form that allows developers to add the SDK to their iOS app projects as a Swift Package.
4
+
5
+
**Note** The SDK was previously made available as a Git sub-module. This mode is now deprecated and will shortly be removed. We strongly recommend customers add the SDK to their iOS app projects using Xcode’s Swift Package Manager as outlined below.
6
+
7
+
## Swift Package Installation ##
8
+
9
+
1. Open your project in Xcode.
10
+
1. Go to **File > Swift Packages > Add Package Dependency...** and add this repo as a dependency.
11
+
1. Apply your preferred dependency rules.
12
+
1. Ensure that your targets `Build Settings` has `-ObjC` set for `Other Linker Flags`
13
+
14
+
## Moving to Swift Package Manager from a manual install or sub-module ##
15
+
16
+
1. If you have previously had the SDK installed via sub-module, you can remove the sub-module reference in your git repository.
17
+
1. The `BlinkUp.embeddedframework` can be deleted from your Xcode Project.
18
+
1. If you wish, you can remove your targets `Build Settings` for the `Framework Search Paths` that references the old framework.
19
+
20
+
## BlinkUp SDK Documentation ##
21
+
22
+
To learn how to use the BlinkUp SDK in your app, please see [the SDK documentation](./docs/html/index.html) (HTML).
23
+
24
+
## Release Notes and Known Issues ##
25
+
26
+
Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the [SDK documentation in this repo](./docs/html/index.html).
27
+
28
+
## Pull Requests ##
29
+
30
+
The BlinkUp SDK repo is considered solely for consumption by a customer’s project. We will not be accepting pull requests made to this repo. If you have support or related questions concerning the SDK, please submit them through your customer account’s [Electric Imp Support access](https://support.electricimp.com/).
4
31
5
32
## Sub-module Installation ##
6
33
34
+
**Important** This mode is deprecated and will shortly be removed.
35
+
7
36
To install the SDK as a sub-module, navigate to your project repo directory and then enter the following command:
8
37
9
38
```
@@ -22,20 +51,6 @@ To update the sub-module contents at any time, eg. in a build script, call:
22
51
git submodule update --remote
23
52
```
24
53
25
-
## BlinkUp SDK Installation ##
26
-
27
-
To learn how to add the BlinkUp SDK files to your app project, please see the relevant documentation included with each of the SDK:
Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the [SDK documentation in this repo](./sdk/Documentation/html).
34
-
35
-
## Pull Requests ##
36
-
37
-
The BlinkUp SDK repo is considered solely for consumption by a customer’s project. We will not be accepting pull requests made to this repo. If you have support or related questions concerning the SDK, please submit them through your customer account’s [Electric Imp Support access](https://support.electricimp.com/).
0 commit comments