mongodb/mongoid

View on GitHub
README.md

Summary

Maintainability
Test Coverage
Mongoid
[![Gem Version][rubygems-img]][rubygems-url]
[![Inline docs][inch-img]][inch-url]
====

Mongoid is an ODM (Object-Document Mapper) framework for MongoDB in Ruby.

Documentation
-------------

Mongoid has [extensive user documentation](https://www.mongodb.com/docs/mongoid/current/).
[API documentation](https://www.mongodb.com/docs/mongoid/current/api/) is also available.

Mongoid is built on top of the MongoDB Ruby driver which has
[its own user documentation](https://www.mongodb.com/docs/ruby-driver/current/).

Compatibility
-------------

Mongoid supports and is tested against:

- MRI 2.7 - 3.1
- JRuby 9.4
- MongoDB server 3.6 - 6.0

Issues
------

Please use the [MONGOID project](https://jira.mongodb.org/browse/MONGOID/)
in MongoDB JIRA to report issues with Mongoid.

Support
-------

* [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoid)
* [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/mongoid-odm)
* [#mongoid](http://webchat.freenode.net/?channels=mongoid) on Freenode IRC

License
-------

Copyright (c) 2015-Present MongoDB Inc.
Copyright (c) 2009-2016 Durran Jordan

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:

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

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.

[rubygems-img]: https://badge.fury.io/rb/mongoid.svg
[rubygems-url]: http://badge.fury.io/rb/mongoid
[inch-img]: http://inch-ci.org/github/mongodb/mongoid.svg?branch=master
[inch-url]: http://inch-ci.org/github/mongodb/mongoid