osmos-contrib-mongodb/README.md

Mongodb driver for Osmos

# osmos-contrib-mongodb

[![Build Status](https://travis-ci.org/limianwang/osmos-contrib-mongodb.svg?branch=master)](https://travis-ci.org/limianwang/osmos-contrib-mongodb)
[![Coverage Status](https://coveralls.io/repos/limianwang/osmos-contrib-mongodb/badge.svg?branch=master)](https://coveralls.io/r/limianwang/osmos-contrib-mongodb?branch=master)

mongodb Driver for osmos-lite.

This Driver is the split out version from the 1.x version of Osmos.

# Usage

This package will work for osmos-lite@2.x. (As currently osmos-lite is in beta, you will have to install directly from github)

```
npm install mongodb --save

npm install git://github.com/limianwang/osmos-lite#2.x --save
npm install osmos-contrib-mongodb --save
```

```js
var osmos = require('osmos-lite');
var Driver = require('osmos-contrib-mongodb');
var mongodb = require('mongodb');

mongodb.MongoClient.connect(url, options, function(err, db) {
  if(err) {
    return done(err);
  }

  var driver =  new osmosMongo(db);

  osmos.drivers.register('mongodb', driver);

  model = new Model('TestMongo', schema, 'name', 'mongodb');

  model.create(...)
});
```