1.0.0

Author: jmdobry

CHANGELOG.md

@@ -1,3 +1,7 @@
+##### 1.0.0 - 17 August 2017
+
+Stable 1.0.0 release
+
 ##### 1.0.0-rc.1 - 23 August 2016
 
 ###### Backwards compatible changes

CONTRIBUTORS

@@ -5,5 +5,5 @@
 # Names should be added to this file as:
 #   [commit count] Name <email address>
      9  Cory Robinson <[email protected]>
-    42  Jason Dobry <[email protected]>
+    43  Jason Dobry <[email protected]>
      1  John Grogg <[email protected]>

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2016 js-data-mongodb project authors
+Copyright (c) 2014-2017 js-data-mongodb project authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -11,7 +11,27 @@
 
 A MongoDB adapter for the [JSData Node.js ORM][11].
 
-### Just getting started?
+### Installation
+
+    npm install --save js-data js-data-mongodb bson mongodb
+
+### Usage
+
+```js
+import { MongoDBAdapter } from 'js-data-mongodb';
+
+// Create an instance of MongoDBAdapter
+const adapter = new MongoDBAdapter({
+  uri: 'mongodb://localhost:27017'
+});
+
+// Other JSData setup hidden
+
+// Register the adapter instance
+store.registerAdapter('mongodb', adapter, { default: true });
+```
+
+### JSData + MongoDB Tutorial
 
 Start with the [JSData + MongoDB tutorial][12] or checkout the [API Reference Documentation][13].
 
@@ -33,7 +53,7 @@ Thank you!
 
 [The MIT License (MIT)][17]
 
-Copyright (c) 2014-2016 [js-data-mongodb project authors][18]
+Copyright (c) 2014-2017 [js-data-mongodb project authors][18]
 
 [1]: http://slack.js-data.io/badge.svg
 [2]: http://slack.js-data.io

circle.yml

@@ -1,15 +1,26 @@
+# Adjust the behavior of the virtual machine (VM)
+machine:
+  node:
+    version: 6.11.2
+
+# Use for broader build-related configuration
 general:
   branches:
     ignore:
       - gh-pages
-machine:
-  node:
-    version: 6
+
+# Install your project's language-specific dependencies
 dependencies:
   pre:
-    - npm install -g npm
-    - npm install -g codecov nyc
-    - npm install js-data@^3.0.0-rc.4 mongodb bson@^0.4.x
+    - yarn global add nyc codecov
+  override:
+    - yarn
+  cache_directories:
+    - ~/.cache/yarn
+
+# Run your tests
 test:
+  override:
+    - yarn test
   post:
-    - nyc report --reporter=lcov | codecov
+    - nyc report --reporter=lcov > coverage.lcov && codecov

conf.json

@@ -14,7 +14,7 @@
   "templates": {
     "theme": "jsdata",
     "systemName": "js-data-mongodb",
-    "copyright": "js-data-mongodb Copyright © 2014-2016 js-data-mongodb project authors",
+    "copyright": "js-data-mongodb Copyright © 2014-2017 js-data-mongodb project authors",
     "outputSourceFiles": true,
     "linenums": true,
     "footer": "<div style=\"text-align:center\"><a href=\"/\">api.js-data.io</a>&nbsp;&#8226;&nbsp;<a href=\"http://js-data.io\">js-data.io</a></div>",