3.0.0-alpha.3

Author: jmdobry

CHANGELOG.md

@@ -1,3 +1,9 @@
+##### 3.0.0-alpha.3 - 26 February 2016
+
+###### Backwards compatible API changes
+- Removed returnDeletedIds option
+- Added insertOpts, updateOpts, deleteOpts, and runOpts options
+
 ##### 3.0.0-alpha.2 - 26 February 2016
 
 ###### Backwards compatible bug fixes

CONTRIBUTORS

@@ -5,5 +5,5 @@
 # Names should be added to this file as:
 #   [commit count] Name <email address>
      1	InternalFX <bryan@internalfx.com>
-    43	Jason Dobry <jason.dobry@gmail.com>
+    44	Jason Dobry <jason.dobry@gmail.com>
      2	Ollie Relph <ollie@relph.me>

README.md

@@ -28,16 +28,30 @@ To get started, visit __[http://js-data.io](http://www.js-data.io)__.
 `npm install --save js-data js-data-rethinkdb`.
 
 ```js
+// Use Container instead of DataStore on the server
 import {Container} from 'js-data'
 import RethinkDBAdapter from 'js-data-rethinkdb'
 
+// Create a store to hold your Mappers
 const store = new Container()
+
+// Create an instance of RethinkDBAdapter with default settings
 const adapter = new RethinkDBAdapter()
 
-// "store" will now use the RethinkDB adapter for all async operations
-store.registerAdapter('rethinkdb', adapter, { default: true });
+// Mappers in "store" will use the RethinkDB adapter by default
+store.registerAdapter('rethinkdb', adapter, { default: true })
+
+// Create a Mapper that maps to a "user" table
+store.defineMapper('user')
+```
 
-store.defineMapper('user');
+```js
+async function findAllAdminUsers () {
+  // Find all users where "user.role" == "admin"
+  return await store.findAll('user', {
+    role: 'admin'
+  })
+}
 ```
 
 ## Example App