Ignore gh-pages

Author: jmdobry

circle.yml

@@ -1,3 +1,7 @@
+general:
+  branches:
+    ignore:
+      - gh-pages
 machine:
   node:
     version: 4.1.0

package.json

@@ -64,12 +64,12 @@
     "mongodb": ">=1.3.x"
   },
   "devDependencies": {
-    "babel-polyfill": "6.7.4",
+    "babel-polyfill": "6.8.0",
     "babel-preset-es2015-rollup": "1.1.1",
     "istanbul": "0.4.3",
     "js-data-adapter-tests": "^2.0.0-alpha.16",
     "js-data-repo-tools": "0.5.0",
-    "rollup": "0.26.1",
+    "rollup": "0.26.2",
     "rollup-plugin-babel": "2.4.0",
     "source-map-support": "0.4.0",
     "watch": "0.18.0"

src/index.js

@@ -913,6 +913,10 @@ utils.addHiddenPropsToTarget(MongoDBAdapter.prototype, {
 /**
  * Details of the current version of the `js-data-mongodb` module.
  *
+ * @example
+ * import {version} from 'js-data-mongodb'
+ * console.log(version.full)
+ *
  * @name module:js-data-mongodb.version
  * @type {Object}
  * @property {string} version.full The full semver value.
@@ -926,4 +930,33 @@ utils.addHiddenPropsToTarget(MongoDBAdapter.prototype, {
  */
 export const version = '<%= version %>'
 
+/**
+ * {@link MongoDBAdapter} class.
+ *
+ * @example
+ * import {MongoDBAdapter} from 'js-data-mongodb'
+ * const adapter = new MongoDBAdapter()
+ *
+ * @name module:js-data-mongodb.MongoDBAdapter
+ * @see MongoDBAdapter
+ * @type {Constructor}
+ */
+
+/**
+ * Registered as `js-data-mongodb` in NPM.
+ *
+ * @example <caption>Install from NPM</caption>
+ * npm i --save js-data-mongodb@beta js-data@beta mongodb bson
+ *
+ * @example <caption>Load via CommonJS</caption>
+ * var MongoDBAdapter = require('js-data-mongodb').MongoDBAdapter
+ * var adapter = new MongoDBAdapter()
+ *
+ * @example <caption>Load via ES2015 Modules</caption>
+ * import {MongoDBAdapter} from 'js-data-mongodb'
+ * const adapter = new MongoDBAdapter()
+ *
+ * @module js-data-mongodb
+ */
+
 export default MongoDBAdapter