Skip to content

Commit 7b86f9f

Browse files
committed
Update instructions
1 parent 6fdf712 commit 7b86f9f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The Electric Imp BlinkUp SDK for iOS #
22

3-
This repo contains the Electric Imp BlinkUp™ SDK for iOS that it is made available to Electric Imp customers. As such it mirrors the downloadable files hosted by the [Dev Center](https://developer.electricimp.com/manufacturing/sdkdocs), but in a form that allows customer 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 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.
44

55
## Sub-module Installation ##
66

@@ -10,7 +10,7 @@ To install the SDK as a sub-module, navigate to your project repo directory and
1010
git submodule add https://github.com/electricimp/BlinkUpSDK-iOS.git
1111
```
1212

13-
This will add the SDK repo as a sub-module referenced through the file `.gitmodules`, which will be added if it is not present. You can now push your local repo to its origin:
13+
This will add the SDK repo as a sub-module referenced in the file `.gitmodules`, which will be added if it is not yet present. You can now push your local repo to its origin:
1414

1515
```
1616
git push origin <working_branch>
@@ -22,17 +22,19 @@ To update the sub-module contents at any time, eg. in a build script, call:
2222
git submodule update --remote
2323
```
2424

25-
**Note** The BlinkUp SDK repo is considered solely for consumption by a customer’s project. We will not be accepting pull requests made to the BlinkUp SDK 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/).
26-
2725
## BlinkUp SDK Installation ##
2826

29-
To understand how to add the BlinkUp SDK files to your app project, please see the relevant documentation included with each of the SDK:
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:
3028

31-
- [iOS SDK Installation](https://github.com/electricimp/BlinkUpSDK-iOS/blob/master/sdk/Documentation/html/index.html) (HTML)
29+
- [iOS SDK Installation](./sdk/Documentation/html/index.html) (HTML)
3230

3331
## Release Notes and Known Issues ##
3432

35-
Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the SDK documentation in this repo.
33+
Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the [SDK documentation in this repo](./sdk/Documentation).
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/).
3638

3739
---
3840

0 commit comments

Comments
 (0)