Skip to content

Commit

Permalink
Fixed typos in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meirgottlieb committed Jan 23, 2018
1 parent 7390472 commit 4d7d368
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ which result in breaking changes in Hydrate.

* Since MongoClient.connect(...) now returns a MongoClient object instead of a Db object, [createSessionFactory](https://artifacthealth.github.io/hydrate-mongodb/classes/configuration.html#createsessionfactory)
now takes a MongoClient object instead of a Db object.
* The new NodeJS MongoDB driver now requires that a database name be specified inorder to get a Db object. Therefore, the database name
* The new NodeJS MongoDB driver now requires that a database name be specified in order to get a Db object. Therefore, the database name
must now be specified in Hydrate. There are 3 ways this can be done (in order of priority from highest to lowest): 1) Specify the database name in the [@Collection](https://artifacthealth.github.io/hydrate-mongodb/globals.html#collection)
decorator, 2) Provide the database name as an argument to [createSessionFactory](https://artifacthealth.github.io/hydrate-mongodb/classes/configuration.html#createsessionfactory),
or 3) Specify the database name in the [Configuration](https://artifacthealth.github.io/hydrate-mongodb/classes/configuration.html#databaseName).
* The [connection](https://artifacthealth.github.io/hydrate-mongodb/interfaces/sessionfactory.html#connection) property on the SessionFactory
is now a MongoClient object instead of a Db object.
* The MongoDB driver was change to a peer dependency
* In version 2.2 of the MongoDB NodeJS native driver, [domain support was disabled by default](http://mongodb.github.io/node-mongodb-native/2.2/upgrade-migration/main/).
You can enable with parameter the *domainsEnabled* parameter on MongoClient. Domain support is not required for Hydrate, but you should be
You can enable with the *domainsEnabled* parameter on MongoClient. Domain support is not required for Hydrate, but you should be
aware of this change when upgrading the MongoDB driver.

## Installation
Expand Down

0 comments on commit 4d7d368

Please sign in to comment.