Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
smittytone committed Aug 19, 2020
1 parent f813e90 commit a8ad536
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The Electric Imp BlinkUp SDK for Android #

This repo contains the Electric Imp BlinkUp™ SDK for Android 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.
This repo contains the Electric Imp BlinkUp™ SDK for Android 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 build scripts.

## Sub-module Installation ##

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

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:
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:

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

**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/).

## BlinkUp SDK Installation ##

To understand how to add the BlinkUp SDK files to your app project, please see the relevant documentation included with each of the SDK:
To learn how to add the BlinkUp SDK files to your app project, please see the relevant documentation included with each of the SDK:

- [Android SDK Installation](./android/README.md)

## Release Notes and Known Issues ##

Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the SDK documentation in this repo.
Please see the [Dev Center SDK page](https://developer.electricimp.com/manufacturing/sdkdocs), or the [SDK documentation in this repo](./sdk/javadoc).

## Pull Requests ##

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/).

---

Expand Down

0 comments on commit a8ad536

Please sign in to comment.