diff --git a/README.md b/README.md index 8ca66cd..da3f24a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## Loopback MySQL Connector -MySQL connector for Loopback Data. +MySQL connector for LoopBack Data Source Juggler. ## Usage @@ -22,13 +22,16 @@ To use it you need `loopback-datasource-juggler`. 2. Use: ```javascript - var Schema = require('loopback-datasource-juggler').Schema; - var schema = new Schema('mysql', { + var DataSource = require('loopback-datasource-juggler').DataSource; + var dataSource = new DataSource('mysql', { database: 'myapp_test', username: 'root' }); ``` - You can optionally pass a few additional parameters supported by `node-mysql`, most particularly `password` and `collation`. `Collation` currently defaults to `utf8_general_ci`. The `collation` value will also be used to derive the connection charset. + You can optionally pass a few additional parameters supported by `node-mysql`, + most particularly `password` and `collation`. `Collation` currently defaults + to `utf8_general_ci`. The `collation` value will also be used to derive the + connection charset. ## Running tests @@ -36,7 +39,9 @@ To use it you need `loopback-datasource-juggler`. ## Using the `dataType` field/column option with MySQL -The loopback-datasource-juggler MySQL adapter now supports using the `dataType` column/property attribute to specify what MySQL column type is used for many loopback-datasource-juggler types. +The loopback-datasource-juggler MySQL adapter now supports using the `dataType` +column/property attribute to specify what MySQL column type is used for many +loopback-datasource-juggler types. The following type-dataType combinations are supported: *