Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add note about the scope of ORM adapter, and not wrapping model insta…

…nce method functionality. Closes #4
commit 51da11d64b43d570bb15c612aa68691a41faeff3 1 parent f83facd
@ianwhite authored
Showing with 3 additions and 11 deletions.
  1. +3 −11 README.rdoc
View
14 README.rdoc
@@ -2,7 +2,6 @@
Provides a single point of entry for popular ruby ORMs. Its target audience is gem authors who want to support more than one ORM.
-
== Example of use
require 'orm_adapter'
@@ -36,20 +35,13 @@ To write an adapter look at <tt>lib/orm_adapter/adapters/active_record.rb</tt> f
== Goals
-ORM Adapter goal is to support a minimum API used by most of the plugins that needs agnosticism beyond Active Model.
+ORM Adapter's goal is to support a minimum API used by most of the plugins that needs agnosticism beyond Active Model.
ORM Adapter will support only basic methods, as +get+, +find_first+, <tt>create!</tt> and so forth. It is not ORM Adapter's goal to support different query constructions, handle table joins, etc.
-If you need complex queries, we recommend you to subclass ORM Adapters in your plugin and extend it expressing these query conditions as part of your domain logic.
-
-
-== Projects using orm_adapter
-
-* {devise}[http://github.com/plataformatec/devise]
-* {pickle}[http://github.com/ianwhite/pickle]
-
-Get in touch if you want your project added to this list
+ORM adapter provides a consistent API for these basic class or 'factory' methods. It does not attempt to unify the behaviour of model instances returned by these methods. This means that unifying the behaviour of methods such as `model.save`, and `model.valid?` is beyond the scope of orm_adapter.
+If you need complex queries, we recommend you to subclass ORM Adapters in your plugin and extend it expressing these query conditions as part of your domain logic.
== History
Please sign in to comment.
Something went wrong with that request. Please try again.