-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added first part of the new README file
- Loading branch information
1 parent
04af4f0
commit 3745754
Showing
1 changed file
with
15 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Iridium | ||
**A High Performance, IDE Friendly ODM for MongoDB** | ||
|
||
[![NPM Module](https://badge.fury.io/js/iridium.png)](https://npmjs.org/package/iridium) | ||
[![Build Status](https://travis-ci.org/SierraSoftworks/Iridium.png?branch=master)](https://travis-ci.org/SierraSoftworks/Iridium) | ||
[![Coverage Status](https://coveralls.io/repos/SierraSoftworks/Iridium/badge.svg?branch=master)](https://coveralls.io/r/SierraSoftworks/Iridium?branch=typescript) | ||
[![Code Climate](https://codeclimate.com/github/SierraSoftworks/Iridium/badges/gpa.svg)](https://codeclimate.com/github/SierraSoftworks/Iridium) | ||
[![Test Coverage](https://codeclimate.com/github/SierraSoftworks/Iridium/badges/coverage.svg)](https://codeclimate.com/github/SierraSoftworks/Iridium) | ||
|
||
|
||
Iridium is designed to offer a high performance, easy to use and above all, editor friendly ODM for MongoDB on Node.js. | ||
Rather than adopting the "re-implement everything" approach often favoured by ODMs like Mongoose and friends, requiring | ||
you to learn an entirely new API and locking you into a specific coding style, Iridium tries to offer an incredibly | ||
lightweight implementation which makes your life easier where it counts and gets out of your way when you want to do | ||
anything more complex. |