tests cleaned a little, added autoloading of on-disk class defs, added currently...

[dbsrgits/DBIx-Class-Schema-Loader.git] / README

diff --git a/README b/README
index 6016355..99ac7dd 100644 (file)
--- a/README
+++ b/README
@@ -13,6 +13,8 @@ SYNOPSIS
         additional_classes      => [qw/DBIx::Class::Foo/],
         additional_base_classes => [qw/My::Stuff/],
         left_base_classes       => [qw/DBIx::Class::Bar/],
+        components              => [qw/ResultSetManager/],
+        resultset_components    => [qw/AlwaysRS/],
         constraint              => '^foo.*',
         relationships           => 1,
         options                 => { AutoCommit => 1 }, 
@@ -42,15 +44,9 @@ SYNOPSIS
       my $classes = $schema1->loader->classes;
 
       # Use the schema as per normal for DBIx::Class::Schema
-      my $rs = $schema1->resultset($monikers->{table_table})->search(...);
+      my $rs = $schema1->resultset($monikers->{foo_table})->search(...);
 
 DESCRIPTION
-    THIS IS A DEVELOPMENT RELEASE. This is 0.01xxx, the first public
-    releases. Expect things to be broken in various ways. Expect the entire
-    design to be fatally flawed. Expect the interfaces to change if it
-    becomes neccessary. It's mostly here for people to poke at it and find
-    the flaws in it. 0.02 will hopefully have some sanity when we get there.
-
     DBIx::Class::Schema::Loader automates the definition of a
     DBIx::Class::Schema by scanning table schemas and setting up columns and
     primary keys.
@@ -63,6 +59,23 @@ DESCRIPTION
     This module requires DBIx::Class 0.05 or later, and obsoletes
     DBIx::Class::Loader for DBIx::Class version 0.05 and later.
 
+    While on the whole, the bare table definitions are fairly
+    straightforward, relationship creation is somewhat heuristic, especially
+    in the choosing of relationship types, join types, and relationship
+    names. The relationships generated by this module will probably never be
+    as well-defined as hand-generated ones. Because of this, over time a
+    complex project will probably wish to migrate off of
+    DBIx::Class::Schema::Loader.
+
+    It is designed more to get you up and running quickly against an
+    existing database, or to be effective for simple situations, rather than
+    to be what you use in the long term for a complex database/project.
+
+    That being said, transitioning your code from a Schema generated by this
+    module to one that doesn't use this module should be straightforward and
+    painless, so don't shy away from it just for fears of the transition
+    down the road.
+
 METHODS
   load_from_connection
     Example in Synopsis above demonstrates the available arguments. For
@@ -75,8 +88,14 @@ METHODS
     during construction. See the DBIx::Class::Schema::Loader::Generic docs
     for more information on the available loader methods there.
 
+KNOWN BUGS
+    Aside from relationship definitions being less than ideal in general,
+    this version is known not to handle the case of multiple relationships
+    between the same pair of tables. All of the relationship code will be
+    overhauled on the way to 0.03, at which time that bug will be addressed.
+
 AUTHOR
-    Brandon Black, "bblack@gmail.com"
+    Brandon Black, "blblack@gmail.com"
 
     Based on DBIx::Class::Loader by Sebastian Riedel