Updated documentation

README.md

@@ -1,57 +1,58 @@
-## hapi-sequelize - a hapi plugin for the sequelize orm
+## hapi-sequelize - a hapi plugin for the sequelize ORM
 
 [![Build Status](https://travis-ci.org/fredguile/hapi-sequelize.svg?branch=master)](https://travis-ci.org/fredguile/hapi-sequelize)
 [![Coverage Status](https://coveralls.io/repos/github/fredguile/hapi-sequelize/badge.svg)](https://coveralls.io/github/fredguile/hapi-sequelize)
 [![npm](https://img.shields.io/npm/dm/localeval.svg)](https://www.npmjs.com/package/@fredguile/hapi-sequelize)
 
-
 ### Important infos
 
-This version of `hapi-sequelize` should be compatible with Hapi 17.x & Sequelize 4.x. If you're
+This version of `hapi-sequelize` is compatible with Hapi 17.x & Sequelize 4.x. If you're
 encountering an issue related to any specific version please open an issue.
- 
+
 ### Installation
 
 `npm install --save @fredguile/hapi-sequelize`
 
 ### Configuration
 
 Simply pass in your sequelize instance and a few basic options and voila. Options accepts a single object
- or an array for multiple dbs.
+or an array for multiple dbs.
 
 ```javascript
-server.register([
-  {
-      plugin: require('hapi-sequelize').plugin,
-      options: [ 
-        {
-          name: 'dbname', // identifier
-          models: ['./server/models/**/*.js'],  // paths/globs to model files
-          sequelize: new Sequelize(config, opts), // sequelize instance
-          sync: true, // sync models - default false
-          forceSync: false, // force sync (drops tables) - default false
-          onConnect: function (database) { // Optional
-            // migrations, seeders, etc.
-          }
-        }
-      ]
-  }
-]);
+await server.register({
+  plugin: require("hapi-sequelize"),
+  options: [
+    {
+      name: "dbname", // identifier
+      models: ["./server/models/**/*.js"], // paths/globs to model files
+      sequelize: new Sequelize(config, opts), // sequelize instance
+      sync: true, // sync models - default false
+      forceSync: false, // force sync (drops tables) - default false
+      onConnect: function(sequelize) {
+        // Optional
+        // migrations, seeders, etc.
+      }
+    }
+  ]
+});
 ```
 
 ### Database Instances
 
-Each registration adds a DB instance to the `server.plugins['hapi-sequelize']` object with the
+Each registration adds a DB instance to the `server.plugins['@fredguile/hapi-sequelize']` object with the
 name option as the key.
 
 ```javascript
 function DB(sequelize, models) {
   this.sequelize = sequelize;
   this.models = models;
-} 
+}
 
 // smth like this
-server.plugins['hapi-sequelize'][opts.name] = new DB(opts.sequelize, models);
+server.plugins["@fredguile/hapi-sequelize"][opts.name] = new DB(
+  opts.sequelize,
+  models
+);
 ```
 
 ### API
@@ -78,9 +79,10 @@ Returns single model that matches the passed argument or null if the model doesn
 
 Returns all models on the db instance
 
-### Contributing 
- If you have any ideas for useful additions to the API or any other improvements to the plugin
- please open an issue or a PR. 
-
- Also feel free to tackle any of the outstanding todo's in the issues. These are mostly currently
- for testing, documentation. I hope to at least provide a reliable, developer friendly plugin.
+### Contributing
+
+If you have any ideas for useful additions to the API or any other improvements to the plugin
+please open an issue or a PR.
+
+Also feel free to tackle any of the outstanding todo's in the issues. These are mostly currently
+for testing, documentation. I hope to at least provide a reliable, developer friendly plugin.