Skip to content

Commit

Permalink
doc: Update README with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
notheotherben committed Apr 14, 2016
1 parent baa6a74 commit 45723b5
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ anything more complex.
It also means that, if you're familiar with the MongoDB CLI you should find working with Iridium very natural, with all database
methods returning promises for their results and sensible, type annotated results being provided if you wish to make use of them.

## Installation
Iridium is a relatively complex library, as a result its installation requires a little more than just `npm install` to get right.
This is, unfortunately, a result of the way TypeScript handles modules at the moment - but they're working on making the workflow
better and we'll always try to stay as up to date as possible.

```bash
npm install iridium --save

typings install -S 'npm!bluebird' 'npm!mongodb' 'npm!lodash'
typings install -SA node es6-promise # don't install es6-promise if you're targetting ES6
```

- **ES6 Users** - If you're targetting ES6, then you'll want to ensure that you don't install es6-promise above. It will conflict with
the ES6 promise library and cause problems.

## Features
- **Built with TypeScript** and designed for ease of use, you'll be hard pressed to find another Node.js ORM as easy to pick
up and learn when combined with a supporting editor.
Expand Down Expand Up @@ -49,7 +64,6 @@ as change tracking when calling `save()` on the instance. If you'd prefer a ligh
implementation then you can do so by taking a look at the [Custom Instances](#custom-instances) section.

```typescript
/// <reference path="node_modules/iridium/index.d.ts" />
import {Core, Model, Instance, Collection, Index, Property, ObjectID} Iridium from 'iridium';

interface Colour {
Expand Down

0 comments on commit 45723b5

Please sign in to comment.