Skip to content

Commit 660d13f

Browse files
committed
Remove links to SDK docs from main README
1 parent da0a9b3 commit 660d13f

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
>
66
77
<picture>
8-
<source srcset="./media/logo-dark.svg" media="(prefers-color-scheme: dark)" alt="realm by MongoDB">
9-
<img src="./media/logo.svg" alt="realm by MongoDB">
8+
<source srcset="./media/logo-dark.svg" media="(prefers-color-scheme: dark)" alt="realm">
9+
<img src="./media/logo.svg" alt="realm">
1010
</picture>
1111

1212
[![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)
@@ -29,12 +29,14 @@ The [Realm Kotlin SDK](https://github.com/realm/realm-kotlin) is now GA and can
2929

3030
## Getting Started
3131

32-
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.
32+
Please see the [Quick Start](docs/guides/quick-start-local.md) to add Realm to your project.
3333

3434
## Documentation
3535

36-
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/).
37-
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/).
36+
Documentation for Realm can be found in the [docs/](docs/README.md) directory.
37+
38+
The Javadoc and Kotlin Extensions API Reference docs can be generated
39+
from source.
3840

3941
## Getting Help
4042

@@ -222,8 +224,6 @@ that you can run `./gradlew :realm:realm-library:compileBaseDebugAndroidTestSour
222224
223225
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()`.
224226
225-
Standalone examples can be [downloaded from website](https://www.mongodb.com/docs/realm/sdk/java/quick-starts/quick-start-local/#complete-example).
226-
227227
## Running Tests on a Device
228228
229229
To run these tests, you must have a device connected to the build computer, and the `adb` command must be in your `PATH`

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ Live objects mean that your data is always up-to-date.
3434
You can register a notification handler to watch for changes and perform some
3535
logic, such as updating your UI.
3636

37+
## Examples
38+
39+
See the [examples/](examples/) directory.

0 commit comments

Comments
 (0)