From 635bae7e48f1278ef671be741de4ad181c447fef Mon Sep 17 00:00:00 2001
From: Vitus <vitusortner.dev@gmail.com>
Date: Sat, 25 Jan 2020 23:04:16 +0100
Subject: [PATCH] Update README with ignore annotation and positional and named
 parameters (#249)

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index 92d109eb..0732e2f9 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,7 @@ This package is still in an early phase and the API will likely change.
 1. [Migrations](#migrations)
 1. [In-Memory Database](#in-memory-database)
 1. [Callback](#callback)
+1. [Ignore Fields](#ignore-fields)
 1. [Examples](#examples)
 1. [Naming](#naming)
 1. [Bugs and Feedback](#bugs-and-feedback)
@@ -305,6 +306,11 @@ For more information about primary keys and especially compound primary keys, re
 `@ColumnInfo` enables custom mapping of single table columns.
 With the annotation, it's possible to give columns a custom name and define if the column is able to store `null`.
 
+`@ignore` excludes annotated fields from the library's mapping.
+More information on that can be found in the [Ignore Fields](#ignore-fields) section.
+
+Constructors with positional and named parameters are supported out of the box.
+
 ```dart
 @Entity(tableName: 'person')
 class Person {
@@ -456,6 +462,24 @@ final database = await $FloorAppDatabase
     .build();
 ```
 
+## Ignore Fields
+The `hashCode` property and all static fields of entities are ignored by default and thus excluded from the library's mapping.
+In case further fields should be ignored, the `@ignore` annotation should be used and applied as shown in the following snippet.
+
+```dart
+class Person {
+  @primaryKey
+  final int id;
+
+  final String name;
+
+  @ignore
+  String nickname;
+
+  Person(this.id, this.name);
+}
+```
+
 ## Examples
 For further examples take a look at the [example](https://github.com/vitusortner/floor/tree/develop/example) and [floor_test](https://github.com/vitusortner/floor/tree/develop/floor_test) directories.