diff --git a/README.mk2.md b/README.mk2.md new file mode 100644 index 0000000..ac8f0ba --- /dev/null +++ b/README.mk2.md @@ -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. \ No newline at end of file