Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nataniel López committed Jul 12, 2019
1 parent c3c6b90 commit 01066a9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Expand Up @@ -6,7 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Added
- Protocol field in config

## [1.1.0] - 2019-07-05
### Added
- MongoDB wrapper
- Tests
Expand All @@ -28,4 +31,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Model `getTable()` method into `table` static getter
- `getFilter()` now only get filters from the unique indexes of the model
- `get()`, `update()` and `multiRemove()` can use any items in the filters
- host field in config not need mongodb protocol anymore
- host field in config not need mongodb protocol anymore

## [1.0.0] - 2019-05-17
### Added
- Initial version
6 changes: 4 additions & 2 deletions README.md
Expand Up @@ -17,7 +17,8 @@ Constructs the MongoDB driver instance, connected with the `config [Object]`.
Config usage:
```js
{
host: 'localhost', // "mongodb://" not needed
protocol: 'mongodb://', // Default "mongodb://"
host: 'localhost', // Default "localhost"
port: 27017, // Default 27017
limit: 500, // Default 500
user: 'fizzmod',
Expand Down Expand Up @@ -126,7 +127,8 @@ const MongoDB = require('@janiscommerce/mongodb');
const Model = require('myModel');

const mongo = new MongoDB({
host: 'localhost', // mongodb:// not needed
protocol: 'mongodb://',
host: 'localhost',
port: 27017
user: 'fizzmod',
password: 'sarasa',
Expand Down

0 comments on commit 01066a9

Please sign in to comment.