From 3ede797c272b740726682d134cc21de94120f331 Mon Sep 17 00:00:00 2001 From: Roman Jurkov Date: Mon, 31 Oct 2016 17:43:18 -0400 Subject: [PATCH] updated readme --- README.md | 102 +----------------------------------------------------- 1 file changed, 1 insertion(+), 101 deletions(-) diff --git a/README.md b/README.md index 7b147e4..2a8e946 100644 --- a/README.md +++ b/README.md @@ -1,101 +1 @@ -[![Build Status](https://travis-ci.org/mccormicka/Mockgoose.png?branch=master)](https://travis-ci.org/mccormicka/Mockgoose) - -Please Share on Twitter if you like #mockgoose - - - - -## What is Mockgoose? - -Mockgoose provides test database by spinning up mongod on the back when mongoose.connect call is made. By default it is using in memory store which does not have persistence. - -## Install -To install the latest official version, use NPM: - - npm install mockgoose --save-dev - - -## Usage -You simply require Mongoose and Mockgoose and wrap Mongoose with Mockgoose. - - var mongoose = require('mongoose'); - var mockgoose = require('mockgoose'); - - mockgoose(mongoose).then(function() { - // mongoose connection - }); - -Once Mongoose has been wrapped by Mockgoose connect() will be intercepted by Mockgoose so that no MongoDB instance is created. - -## Mocha - -```javascript -var Mongoose = require('mongoose').Mongoose; -var mongoose = new Mongoose(); - -var mockgoose = require('mockgoose'); - -before(function(done) { - mockgoose(mongoose).then(function() { - mongoose.connect('mongodb://example.com/TestingDB', function(err) { - done(err); - }); - }); -}); - -describe('...', function() { - it("...", function(done) { - // ... - done(); - }); -}); -``` - -## Helper methods and variables - -### reset(callback) -Reset method will remove **ALL** of the collections from a temporary store, -note that this method is part of **mockgoose** object, and not defined under -**mongoose** - -```javascript -mockgoose.reset(function() { - done() -}); -``` - -### isMocked -Returns **TRUE** from **mongoose** object if Mockgoose is applied - -```javascript -if ( mongoose.isMocked === true ) { - // mongoose object is mocked -} -``` - -## unmock(callback) -Method that can be applied on **mongoose** to remove modifications added -by **mockgoose**, it will perform disconnect on temporary store that was -created, and **will not reconnect** - -## unmockAndReconnect(callback) -Same as **unmock**, however it will reconnect to original URI that was -passed during **connect** - -## Development - -This section contains instructions for developers working on the Mockgoose codebase. -It is not relevant if you just want to use Mockgoose as a library in your project. - -### Pre-requisites - -* Node.js >= 0.10.0 - -### Setup - -``` -git clone git@github.com:mccormicka/Mockgoose.git -cd Mockgoose -npm install -npm test -``` +## Project was moved to https://github.com/mockgoose/mockgoose