jmdobry/reheat

<div class="span12">
    <div class="row">
        <div class="span4">
            <documentation-group-list></documentation-group-list>
        </div>
        <div class="span8">
            <h1>
                Reheat
                <a href="https://travis-ci.org/jmdobry/reheat">
                    <img src="https://travis-ci.org/jmdobry/reheat.png?branch=master" alt="Build Status"
                         style="max-width:100%;">
                </a>
                <a href="https://codeclimate.com/github/jmdobry/reheat">
                    <img src="https://codeclimate.com/github/jmdobry/reheat.png" alt="Code Climate"
                         style="max-width:100%;">
                </a>
                <a href="https://gemnasium.com/jmdobry/reheat">
                    <img src="https://gemnasium.com/jmdobry/reheat.png" alt="Dependency Status"
                         style="max-width:100%;">
                </a>
                <a href='https://coveralls.io/r/jmdobry/reheat'>
                    <img src='https://coveralls.io/repos/jmdobry/reheat/badge.png' alt='Coverage Status'/>
                </a>
            </h1>

            <p>
                RethinkDB is awesome and ReQL makes queries fun to write, but still, who loves writing tons of database
                access code? Reheat exists to eliminate boilerplate and level up your RethinkDB experience!
            </p>

            <p style="font-size: 16px; color: #d14;">This is beta software! API may fluctuate before 1.0.0.</p>

            <p>You can use it, but be prepared to keep a close eye on the changelog.</p>

            <h3>
                <a name="benefits" href="#benefits"></a>Benefits
            </h3>

            <p>
                <a href="https://nodei.co/npm/reheat/" class="pull-right">
                    <img src="https://nodei.co/npm/reheat.png?downloads=true">
                </a>
            <ul>
                <li>Less code to write</li>
                <li>Less code to test</li>
                <li>Less code to maintain</li>
                <li>Less code that can break</li>
                <li>Improved sense of well-being</li>
            </ul>
            </p>

            <h3><a name="features" href="#features"></a>Features:</h3>

            <ul>
                <li>Managed connection pool</li>
                <li>Entire API supports Promises and Node-style callbacks</li>
                <li>
                    Easy hooks into Model lifecycle (<code>beforeUpdate()</code>, <code>afterDestroy()</code>, etc.)
                </li>
                <li>Robust and flexible Schema definition for your Models</li>
                <li>Automatic validation based on Schema</li>
                <li>Easy filtering/querying</li>
                <li>Query builder (it's just ReQL, easy!)</li>
                <li>Connection and Schema can each be used on their own</li>
                <li>Relationship/Associations</li>
            </ul>
            <h3><a name="roadmap" href="#roadmap"></a>Roadmap:</h3>

            <ul>
                <li>1.0.0</li>
                <li>You tell me!</li>
            </ul>
            <h2>
                <a name="quick-what-is-rethinkdb" href="#quick-what-is-rethinkdb"></a>Quick, what is
                RethinkDB?
            </h2>

            <p>From the RethinkDB website:</p>

            <blockquote>
                <p>An open-source distributed database built with love.</p>

                <p>Enjoy an <em>intuitive</em> query language, automatically <em>parallelized</em> queries, and <em>simple</em>
                    administration.</p>

                <p>Table joins and batteries included.</p>
            </blockquote>

            <h2>
                <a name="license" href="#license"></a>License
            </h2>

            <p><a href="https://github.com/jmdobry/reheat/blob/master/LICENSE">MIT License</a></p>

            <p>Copyright (C) 2013-2014 Jason Dobry</p>

            <p>
                Permission is hereby granted, free of charge, to any person obtaining a copy of
                this software and associated documentation files (the "Software"), to deal in
                the Software without restriction, including without limitation the rights to
                use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
                of the Software, and to permit persons to whom the Software is furnished to do
                so, subject to the following conditions:
            </p>

            <p>
                The above copyright notice and this permission notice shall be included in all
                copies or substantial portions of the Software.
            </p>

            <p>
                THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
                FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
                COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
                IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
                CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
            </p>
        </div>
    </div>
</div>