mrpastewart/platform
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Tobe O 2019-04-03 05:59:23 -04:00
parent 832601c8c5
commit e11b84ad55
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -34,7 +34,7 @@ However, it also includes a `build.yaml` that builds ORM files automatically, so
have to do any configuration at all. have to do any configuration at all.
# Models # Models
Your model, courtesy of `package:angel_serialize`: The ORM works best when used with `package:angel_serialize`:
```dart ```dart
library angel_orm.test.models.car; library angel_orm.test.models.car;
@ -67,17 +67,14 @@ Models can use the `@SerializableField()` annotation; `package:angel_orm` obeys
After building, you'll have access to a `Query` class with strongly-typed methods that After building, you'll have access to a `Query` class with strongly-typed methods that
allow to run asynchronous queries without a headache. allow to run asynchronous queries without a headache.
**IMPORTANT:** The ORM *assumes* that you are using `package:angel_serialize`, and will only generate code Remember that if you don't need automatic id-and-date fields, you can
designed for such a workflow. Save yourself a headache and build models with `angel_serialize`: simply just not extend `Model`:
https://github.com/angel-dart/serialize
Remember that if you don't need automatic id-and-date fields, you can do the following:
```dart ```dart
@Serializable(autoIdAndDateFields: false) @Serializable(autoIdAndDateFields: false)
abstract class _ThisIsNotAnAngelModel { abstract class _ThisIsNotAnAngelModel {
@primaryKey
String get username;
} }
``` ```