README in og-0.16.0 vs README in og-0.17.0
- old
+ new
@@ -1,6 +1,6 @@
-= Og 0.16.0 README
+= Og 0.17.0 README
Og (ObjectGraph) is a powerfull object-relational mapping library. Og provides
transparent serialization of object graphs to a RDBMS
backend. Unlike other similar libraries Og maps standard Ruby
objects to SQL tables and not vice versa. Og provides a meta language
@@ -25,35 +25,43 @@
The library provides the following features:
+ Object-Relational mapping.
+ Absolutely no configuration files.
-+ Multiple backend adapters (PostgreSQL, MySQL, SQLite3, Oracle, SqlServer).
++ Multiple stores (PostgreSQL, MySQL, SQLite, Oraclei, SqlServer, ..).
++ Supports non SQL stores.
+ ActiveRecord-style meta language and db aware methods.
-+ Automatially generates join-tables for many_to_many relations.
-+ Deserialize sql join queries to Ruby Objects (coming soon).
++ Deserialize to Ruby Objects.
++ Deserialize sql join queries to Ruby Objects.
++ Eager associations.
+ Serialize arbitrary ruby object graphs through YAML.
+ Connection pooling.
-+ Thread safety.
++ Thread safety (temporarily dissabled).
+ SQL transactions.
-+ Lifecycle event interception and Observers.
++ Aspect oriented constructs allow interception of lifecycle callbacks.
+ Transparent support for cascading deletes for all backends.
-+ Dynamic db related mixins (Orderable, etc).
-+ Hierarchical structures (nested sets, more coming soon).
-+ Works safely as part of a distributed application.
-+ Automatic Validation/Constraints.
-+ Simple and clean implementation.
++ Hierarchical structures (nested sets)
++ Works safely as part of distributed application.
++ Simple implementation.
+== What's new
+
+For information about the latest changes please consult the
+file
+
+doc/RELEASES
+
+
== Download
The latest version of Og can be found at
* http://nitro.rubyforge.org
Documentation for Og can be found in the distribution. You can find
-a nice tutorial at www.rubygarden.com
+a nice tutorial at www.rubygarden.com.
== Requirements
Og requires the following applications or libraries:
@@ -67,19 +75,24 @@
Ruby interface to the PostgreSQL RDBMS.
* Ruby-mysql
http://tmtm.org/ja/ruby/mysql/README_en.html
Ruby interface to the MySQL RDBMS.
+ Pure Ruby Mysql interface:
+ http://www.tmtm.org/ruby/mysql/
* PostgreSQL
http://www.postgres.org
Used for the Database Backend.
* MySQL
http://www.mysql.org
Used for the Database Backend.
+* SQLite
+ http://www.sqlite.org/download.html
+
Please install the required applications and libraries before continuing
with the installation of Og. Only install the libraries needed for
the backend you plan to use.
@@ -94,9 +107,19 @@
installed)
Then try to run the examples in the examples directory.
A tar.gz distribution is also available on http://www.rubyforge.com/projects/nitro.
+
+
+== Examples:
+
+Some examples can be found in the examples directory. You are also
+encouraged to check out the unit tests. Especially the test:
+
+test/og/tc_store.rb
+
+demonstrates some advanced features of Og.
== Support
For any questions regarding Og, feel free to ask on the ruby-talk