Skip to content

Commit

Permalink
Continued updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
notheotherben committed Apr 23, 2015
1 parent 06b16b6 commit 462b6eb
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Iridium [![Build Status](https://travis-ci.org/SierraSoftworks/Iridium.png?branch=master)](https://travis-ci.org/SierraSoftworks/Iridium) [![](https://badge.fury.io/js/iridium.png)](https://npmjs.org/package/iridium)
**A bare metal ORM for MongoDB**
**A bare metal ODM for MongoDB**

Iridium isn't your traditional JavaScript ORM, it's the ORM I've always wanted and I hope you'll enjoy using it as much
as I do. With Iridium, your models are simply JavaScript classes (if you're using ES6 or TypeScript) which means that
you don't need to learn a new DSL just to define your database structure and that your favourite editor will be able
to understand your code and provide useful suggestions.

## NOT YET FINISHED
The TypeScript implementation of Iridium is not yet finished - if you'd like to help out then please get in touch but **DO NOT START BUILDING APPS USING IT YET**. Seriously, it doesn't even have an official version number yet - everything is subject to change.
Expand Down

0 comments on commit 462b6eb

Please sign in to comment.