Skip to content

Commit

Permalink
Added installation instructions, as per new NPM package.
Browse files Browse the repository at this point in the history
  • Loading branch information
jameshfisher committed Jul 4, 2010
1 parent 3f1bc8f commit d2ed12b
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Expand Up @@ -10,13 +10,25 @@ The goal of Mongoose is to provide a extremely simple interface for MongoDB.
- Ability to model your data with custom interfaces.
- Allows for complex business logic in an async way (see `Promises`).


## How to install

#. Install the [npm](http://github.com/isaacs/npm) package manager
#. Install [node-mongodb-native](http://github.com/christkv/node-mongodb-native),
on top of which Mongoose runs
#. Run this to install:

git clone http://github.com/LearnBoost/mongoose.git
cd mongoose
sudo npm install .


## How to use

### Setup

In your application, add mongoose to the requires path:
Simply require Mongoose:

require.paths.unshift('vendor/mongoose');
var mongoose = require('mongoose').Mongoose;

### Defining a model
Expand Down Expand Up @@ -346,4 +358,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit d2ed12b

Please sign in to comment.