Skip to content

Commit

Permalink
doc: Update README to remove reference to typings
Browse files Browse the repository at this point in the history
  • Loading branch information
notheotherben committed Sep 28, 2016
1 parent 3f1242d commit ff519b7
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,13 @@ It also means that, if you're familiar with the MongoDB CLI you should find work
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.
Iridium makes use of the latest set of `@types` TypeScript definitions files, allowing you to install everything using just a
simple `npm install`.

```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

0 comments on commit ff519b7

Please sign in to comment.