From 027f1580dcf0a79acb5a2041aad83cf7c23a04c3 Mon Sep 17 00:00:00 2001
From: Oriol Gual <oriol.gual@gmail.com>
Date: Mon, 27 Aug 2012 11:51:16 +0300
Subject: [PATCH] Document how to embed ids or objects per association

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

diff --git a/README.md b/README.md
index aeb19a39..a6c96e8f 100644
--- a/README.md
+++ b/README.md
@@ -330,6 +330,33 @@ Now, any associations will be supplied as an Array of IDs:
 }
 ```
 
+Alternatively, you can choose to embed only the ids or the associated objects per association:
+
+```ruby
+class PostSerializer < ActiveModel::Serializer
+  attributes :id, :title, :body
+  
+  has_many :comments, embed: :objects
+  has_many :tags, embed: :ids
+end
+```
+
+The JSON will look like this:
+
+```json
+{
+  "post": {
+    "id": 1,
+    "title": "New post",
+    "body": "A body!",
+    "comments": [
+      { "id": 1, "body": "what a dumb post" }
+    ],
+    "tags": [ 1, 2, 3 ]
+  }
+}
+```
+
 In addition to supplying an Array of IDs, you may want to side-load the data
 alongside the main object. This makes it easier to process the entire package
 of data without having to recursively scan the tree looking for embedded