Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
>

<picture>
<source srcset="./media/logo-dark.svg" media="(prefers-color-scheme: dark)" alt="realm by MongoDB">
<img src="./media/logo.svg" alt="realm by MongoDB">
<source srcset="./media/logo-dark.svg" media="(prefers-color-scheme: dark)" alt="realm">
<img src="./media/logo.svg" alt="realm">
</picture>

[![Maven Central](https://img.shields.io/maven-central/v/io.realm/realm-gradle-plugin?colorB=4dc427&label=Maven%20Central)](https://search.maven.org/artifact/io.realm/realm-gradle-plugin)
Expand All @@ -29,12 +29,14 @@ The [Realm Kotlin SDK](https://github.com/realm/realm-kotlin) is now GA and can

## Getting Started

Please see the [detailed instructions in our docs](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/install/) to add Realm to your project.
Please see the [Quick Start](docs/guides/quick-start-local.md) to add Realm to your project.

## Documentation

Documentation for Realm can be found at [mongodb.com/docs/atlas/device-sdks/sdk/java/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/).
The API reference is located at [mongodb.com/docs/atlas/device-sdks/sdk/java/api/](https://www.mongodb.com/docs/atlas/device-sdks/sdk/java/api/).
Documentation for Realm can be found in the [docs/](docs/README.md) directory.

The Javadoc and Kotlin Extensions API Reference docs can be generated
from source.

## Getting Help

Expand Down Expand Up @@ -222,8 +224,6 @@ that you can run `./gradlew :realm:realm-library:compileBaseDebugAndroidTestSour

The `./examples` folder contains many example projects showing how Realm can be used. If this is the first time you checkout or pull a new version of this repository to try the examples, you must call `./gradlew installRealmJava` from the top-level directory first. Otherwise, the examples will not compile as they depend on all Realm artifacts being installed in `mavenLocal()`.

Standalone examples can be [downloaded from website](https://www.mongodb.com/docs/realm/sdk/java/quick-starts/quick-start-local/#complete-example).

## Running Tests on a Device

To run these tests, you must have a device connected to the build computer, and the `adb` command must be in your `PATH`
Expand Down
39 changes: 39 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Realm SDK for Java
Use the Realm SDK for Java to develop Android apps in Java or Kotlin.
To develop multiplatform apps using Kotlin Multiplatform (KMP), refer to the
Kotlin SDK.

## SDK in Maintenance Mode
This SDK is in best-effort maintenance mode and **no longer receives
new development or non-critical bug fixes**. To develop your app with new
features, use the Kotlin SDK. You can use the Java SDK with the Kotlin SDK.

## Develop Apps with the SDK
Use the SDK's open-source database - Realm - as an object store on the device.

### Install the Java SDK
Use the Gradle build system to
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't remember the original docs website structure, but this readme seems a bit odd - like it's missing code snippets or some links.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, it's not ideal. this was originally the landing page, stripped of any links to MongoDB docs or the API ref (hosted on mdb)

install the Java SDK in your project.

### Define an Object Schema
Use Java or Kotlin to idiomatically define an object schema.

### Open a Database
The SDK's database - Realm - stores objects in files on your device.
Or you can open an in-memory database which does not create a file.
To get started reading and writing data,
configure and open a database.

### Read and Write Data
Create, read, update, and
delete objects from the database.
Use Android-native queries to filter data.

### React to Changes
Live objects mean that your data is always up-to-date.
You can register a notification handler to watch for changes and perform some
logic, such as updating your UI.

## Examples

See the [examples/](..examples/) directory.
Loading
Loading