Reimplement as a plugin for Bookshelf/Knex 0.8.x

.jscs.json

@@ -0,0 +1,7 @@
+{
+  "preset": "node-style-guide",
+  "requireCamelCaseOrUpperCaseIdentifiers": "ignoreProperties",
+  "maximumLineLength": null,
+  "requireTrailingComma": null,
+  "disallowTrailingComma": true
+}

.jshintrc

@@ -0,0 +1,3 @@
+{
+  "node": true
+}

README.md

@@ -7,6 +7,46 @@
 > Model & Collection manager for [Bookshelf.js][1] to make it easy to create &
 > save deep, nested JSON structures from API requests.
 
+## Installation
+
+    npm install bookshelf-manager --save
+
+## Usage
+
+  1. Register as a plugin in Bookshelf:
+
+     ```javascript
+     bookshelf.plugin('bookshelf-manager');
+     ```
+
+      - Optionally, you can pass in an object with a `root` property to read models from a specified directory:
+
+         ```javascript
+         bookshelf.plugin('bookshelf-manager', { root: 'path/to/models' });
+         ```
+
+  2. Register individual models (not required if you passed in a `root` model directory as above):
+
+     ```javascript
+     bookshelf.manager.register(model, modelName);
+     ```
+
+     - Note: Also compatible with models registered with the [Bookshelf Registry](https://github.com/tgriesser/bookshelf/wiki/Plugin:-Model-Registry) plugin.
+
+  3. Use the methods on `bookshelf.manager` to create, fetch, and save models or collections with support for deeply-nested attributes. E.g.:
+
+     ```javascript
+     return bookshelf.manager.create('car', {
+       features: [
+         { name: 'ABS', cost: '1250' },
+         { name: 'GPS', cost: '500' }
+       ],
+       quantity: 1
+     }).then(function(car) {
+       // created car should now have the associated features
+     });
+     ```
+
 
 ## API
 
@@ -15,6 +55,7 @@
 
 ## Changelog
 
+- v0.1.0 - Reimplement as a plugin for Bookshelf/Knex 0.8.x
 - v0.0.10 - Enforce `belongsToMany` IDs
 - v0.0.9 - Destroy removed `hasMany` models
 - v0.0.8 - Fetch empty collections

index.js

@@ -1 +1 @@
-module.exports = require('./lib/manager');
+module.exports = require('./lib/manager').plugin;