diff --git a/README.md b/README.md index e5d2e3e..b5a62de 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Realm is a mobile database that runs directly inside phones, tablets or wearables. -This repository holds adapters for combining Realm Java with Android UI components and framework classes. +This repository holds adapters for combining [realm-java](https://github.com/realm/realm-java) (the Realm Java SDK for Android) with Android UI components and framework classes. Currently supported UI components are: @@ -11,8 +11,9 @@ Currently supported UI components are: ## Getting Started -This library only works together with Realm Java. Please see the [detailed instructions in our docs](https://realm.io/docs/java/#installation) -to add Realm to your project. +This library only works together with the Realm Android SDK. Please see the +[detailed instructions in our docs](https://docs.mongodb.com/realm/sdk/android/examples/adapters/) +for using this library. To add the adapters to your project, add the following to you app's dependencies: @@ -26,12 +27,13 @@ dependencies { } ``` -This library is only compatible with Realm Java 5.0.0 and above. +This library is only compatible with `realm-java` (the Realm Android SDK) 5.0.0 and above. ## Documentation -Documentation for Realm can be found at [realm.io/docs/java](https://realm.io/docs/java). -The API reference is located at [realm.io/docs/java/api](https://realm.io/docs/java/api). +Documentation for Realm can be found at [docs.mongodb.com/realm/](https://docs.mongodb.com/realm/). +The Realm SDK documentation can be found at [docs.mongodb.com/realm/sdk/android/](https://docs.mongodb.com/realm/sdk/android/). +The API reference is located at [docs.mongodb.com/realm-sdks/java/latest/](https://docs.mongodb.com/realm-sdks/java/latest/). ## Getting Help @@ -64,10 +66,10 @@ In case you don't want to use the pre-compiled version, you can build the librar Prerequisites: - * Download/the [**JDK 7**](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html) or [**JDK 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) from Oracle and install it. + * Download [**JDK 7**](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html) or [**JDK 8**](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) and install it. * Download & install the Android SDK, **Android 7.1 (API 25)** (for example through Android Studio’s **Android SDK Manager**) -Once you have completed all the pre-requisites building Realm is done with a simple command +Once you have completed all the pre-requisites building the adapter library is done with a single command: ``` ./gradlew assemble @@ -75,13 +77,14 @@ Once you have completed all the pre-requisites building Realm is done with a sim That command will generate: - * an aar file for the adapter library in `adapters/build/outputs/aar/android-adapters-release.aar` + * an `aar` file for the adapter library (`adapters/build/outputs/aar/android-adapters-release.aar`) ### Other Commands * `./gradlew monkeyDebug` will run the monkey tests on the example project. * `./gradlew javadoc` will create the javadoc for the library. * `./gradlew publishToSonatype` will upload artifacts to Maven Central. + * `./gradlew bintrayUpload` will upload a release to Bintray. ## Contributing @@ -101,4 +104,4 @@ Realm Android Adapters is published under the Apache 2.0 license. **_And if you don't like it, please let us know what you would like improved, so we can fix it!_** -![analytics](https://ga-beacon.appspot.com/UA-50247013-2/realm-android-adapters/README?pixel) +![analytics](https://ga-beacon.appspot.com/UA-50247013-2/realm-android-adapters/README?pixel) \ No newline at end of file