Skip to content

Commit

Permalink
updated readme with api details
Browse files Browse the repository at this point in the history
  • Loading branch information
Kenneth Lee committed Mar 18, 2014
1 parent 9643314 commit 2e9f4bf
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,17 @@ fixtures({
]
});
```

api
---

`fixtures(dataset, <mongoose instance>, <callback>);`

`mongoose instance` is a singular instance of mongoose. This is typically initialized with the following:
```
var Mongoose = require('mongoose').Mongoose;
var mongooseInstance = new Mongoose('mongodb://localhost/dbname');
```

`callback` is the callback function. It's parameters are callback(errors, data documents). Both arguments are arrays. The data documents are mongoose documents from the fixture data.

0 comments on commit 2e9f4bf

Please sign in to comment.