Updating ReadMe.
Project: http://git-wip-us.apache.org/repos/asf/usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid/commit/22110ae3 Tree: http://git-wip-us.apache.org/repos/asf/usergrid/tree/22110ae3 Diff: http://git-wip-us.apache.org/repos/asf/usergrid/diff/22110ae3 Branch: refs/heads/master Commit: 22110ae3c00c09dcfbcf64ce2587da540f498f82 Parents: 8ddc90d Author: Robert Walsh <[email protected]> Authored: Mon Aug 8 17:22:48 2016 -0500 Committer: Robert Walsh <[email protected]> Committed: Mon Aug 8 17:22:48 2016 -0500 ---------------------------------------------------------------------- sdks/android/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid/blob/22110ae3/sdks/android/README.md ---------------------------------------------------------------------- diff --git a/sdks/android/README.md b/sdks/android/README.md index a1cbf41..a45b8d7 100644 --- a/sdks/android/README.md +++ b/sdks/android/README.md @@ -1,6 +1,8 @@ # Usergrid Android SDK -Usergrid SDK written for Android +Usergrid SDK written for Android. + +The Android SDK is an extension upon the the Usergrid Java SDK with added functionality including asynchronous HTTP handling and push notifications. ## Initialization @@ -20,6 +22,14 @@ UsergridClient client = new UsergridClient("orgId","appId"); _Note: Examples in this readme assume you are using the `Usergrid` shared instance. If you've implemented the instance pattern instead, simply replace `Usergrid` with your client instance variable._ +## ASYNCHRONOUS operations + +The examples in this readme utilize the synchronous method calls provided by the Usergrid Java SDK. + +Each RESTful operation has a matching asynchrous method within to use within the SDK for convience of use within Android applications. + +For examples of asynchronous calls, look over the sample Android applications located within the `Samples` folder. + ## RESTful operations When making any RESTful call, a `type` parameter (or `path`) is always required. Whether you specify this as an argument or in an object as a parameter is up to you.
