Skip to content

closes #1824: doc implements #1837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

closes #1824: doc implements #1837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This repository holds the source code for the Realm SDK for Flutter™ and Dart

## Getting Started

* Import Realm in a dart file `app.dart`
* Import Realm in a dart file `app.dart`. Remember to add `part 'app<the file name>.realm.dart'` below the imports or Realm won't generate needed objects automatically, although the language server may complain the URI does not exist.

```dart
import 'package:realm/realm.dart'; // import realm package
Expand Down Expand Up @@ -149,7 +149,7 @@ Realm Flutter package is published to [realm](https://pub.dev/packages/realm).

* Create a data model class.

It should start with an underscore `_Item` and be annotated with `@RealmModel()`
It should start with an underscore `_Item` and be annotated with `@RealmModel()`. If the object needs to be used inside other data model classes, annotate with `@RealmModel(ObjectType.embeddedObject)` instead.

```dart
@RealmModel()
Expand Down