aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdnan Begovic <adnan@cyngn.com>2015-08-07 16:37:24 -0700
committerAdnan Begovic <adnan@cyngn.com>2015-08-07 16:37:24 -0700
commitf4541cdbfcd3982fa1ad967ff1854942423a3089 (patch)
tree8b62c89ff9f0876ea1338ed98e58ced0ae8e95a1 /README.md
parentbb1367a59403c8b7f5611a9042cbec13e92db516 (diff)
downloadvendor_cmsdk-f4541cdbfcd3982fa1ad967ff1854942423a3089.zip
vendor_cmsdk-f4541cdbfcd3982fa1ad967ff1854942423a3089.tar.gz
vendor_cmsdk-f4541cdbfcd3982fa1ad967ff1854942423a3089.tar.bz2
cmsdk: Update readme for maven central deploy.
Change-Id: I8ac9fb19ad97158d1c83c7406df0dd10e0b7ac10
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/README.md b/README.md
index c937594..896c2e4 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,22 @@ The Platform SDK provides a set of APIs that give you easy access to a variety o
You can either [download](https://github.com/CyanogenMod/android_prebuilts_cmsdk/tree/master/current) from prebuilts hosted on github or pull directly via Gradle.
-Within `build.gradle` make sure your `repositories` list sonatype OSS repos
+### Building against release artifacts
+
+Our stable releases are mirrored in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22platform.sdk%22), and you can fetch the current release by setting your `build.gradle` dependencies to
+
+```gradle
+dependencies {
+ compile 'org.cyanogenmod:platform.sdk:1.0'
+}
```
+
+### Buliding against development snapshots
+
+Within `build.gradle` make sure your `repositories` list sonatype OSS repos for snapshots
+
+```gradle
repositories {
maven {
url "https://oss.sonatype.org/content/repositories/snapshots/"
@@ -16,17 +29,9 @@ repositories {
}
```
-To target the current release (for retail devices), set your `dependency` for `1.0-SNAPSHOT`
+You can target the `future` or `development` branch by setting your `dependencies` for `2.0-SNAPSHOT`
-```
-dependencies {
- compile 'org.cyanogenmod:platform.sdk:1.0-SNAPSHOT'
-}
-```
-
-Likewise, you can target the `future` or `development` branch by setting your `dependencies` for `2.0-SNAPSHOT`
-
-```
+```gradle
dependencies {
compile 'org.cyanogenmod:platform.sdk:2.0-SNAPSHOT'
}