Skip to content

Commit da0a9b3

Browse files
committed
Add markdown docs to docs/ dir for community access
1 parent 6a02481 commit da0a9b3

36 files changed

+11261
-0
lines changed

docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Realm SDK for Java
2+
Use the Realm SDK for Java to develop Android apps in Java or Kotlin.
3+
To develop multiplatform apps using Kotlin Multiplatform (KMP), refer to the
4+
Kotlin SDK.
5+
6+
## SDK in Maintenance Mode
7+
This SDK is in best-effort maintenance mode and **no longer receives
8+
new development or non-critical bug fixes**. To develop your app with new
9+
features, use the Kotlin SDK. You can use the Java SDK with the Kotlin SDK.
10+
11+
## Develop Apps with the SDK
12+
Use the SDK's open-source database - Realm - as an object store on the device.
13+
14+
### Install the Java SDK
15+
Use the Gradle build system to
16+
install the Java SDK in your project.
17+
18+
### Define an Object Schema
19+
Use Java or Kotlin to idiomatically define an object schema.
20+
21+
### Open a Database
22+
The SDK's database - Realm - stores objects in files on your device.
23+
Or you can open an in-memory database which does not create a file.
24+
To get started reading and writing data,
25+
configure and open a database.
26+
27+
### Read and Write Data
28+
Create, read, update, and
29+
delete objects from the database.
30+
Use Android-native queries to filter data.
31+
32+
### React to Changes
33+
Live objects mean that your data is always up-to-date.
34+
You can register a notification handler to watch for changes and perform some
35+
logic, such as updating your UI.
36+

0 commit comments

Comments
 (0)