Improve documentation for view method

amco · Aug 31, 2015 · 1904898 · 1904898
1 parent 32e4db1
commit 1904898
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -71,8 +71,9 @@ User.all #Dolly::Collection #<#User...>, <#User...>
 user = User.find "a1b2d3e" #<#User...>
 user.name
 
-#Return a User object based on the custom view.
-user = User.view 'view_name', {key: ["a", "b", "c"], reduce: true}
+#Return a User object based on the custom view. `include_docs` is always true for this method.
+response = User.view '_design/<design_document_name>/_view/<view_name>', {key: <key>, reduce: true}
+user = User.new.from_json response
 
 
 # Save doc