version bumped, added kwalitee, removed old "first release" notice from pod

[catagits/Catalyst-Model-DBIC-Schema.git] / README

diff --git a/README b/README
index f18d5b2..e35d435 100644 (file)
--- a/README
+++ b/README
@@ -22,9 +22,14 @@ SYNOPSIS
         # ->schema To access schema methods:
         $c->model('Foo')->schema->source(...);
 
-        # Shortcut to the schema resultset monikers for ->search et al:
-        $c->model('Foo::Bar')->search(...);
-        # is the same as $c->model('Foo')->schema->resultset('Bar')->search(...);
+        # certain ->schema methods (source, resultset, class) have shortcuts
+        $c->model('Foo')->source(...);
+        $c->model('Foo')->resultset(...);
+        $c->model('Foo')->class(...);
+
+        # For resultsets, there's an even quicker shortcut:
+        $c->model('Foo::Bar')
+        # is the same as $c->model('Foo')->resultset('Bar')
 
         # To get the composed schema for making new connections:
         my $newconn = $c->model('Foo')->composed_schema->connect(...);
@@ -35,21 +40,25 @@ SYNOPSIS
         # or, if your schema works on different storage drivers:
         my $newconn = $c->model('Foo')->composed_schema->clone();
         $newconn->storage_type('::LDAP');
-        $newconn->connect(...);
+        $newconn->connection(...);
 
         # and again, a convenience shortcut
         my $newconn = $c->model('Foo')->clone();
         $newconn->storage_type('::LDAP');
-        $newconn->connect(...);
+        $newconn->connection(...);
 
 DESCRIPTION
-    This is a Catalyst Model for DBIx::Class::Schema-based Models.
+    This is a Catalyst Model for DBIx::Class::Schema-based Models. See the
+    documentation for Catalyst::Helper::Model::DBIC::Schema and
+    Catalyst::Helper::Model::DBIC::SchemaLoader for information on
+    generating these Models via Helper scripts. The latter of the two will
+    also generated a DBIx::Class::Schema::Loader-based Schema class for you.
 
 CONFIG PARAMETERS
     schema_class
         This is the classname of your DBIx::Class::Schema Schema. It needs
         to be findable in @INC, but it does not need to be underneath
-        "Catalyst::Model::".
+        "Catalyst::Model::". This parameter is required.
 
     connect_info
         This is an arrayref of connection parameters, which are specific to
@@ -58,25 +67,34 @@ CONFIG PARAMETERS
         parameters are your dsn, username, password, and connect options
         hashref.
 
+        This is not required if "schema_class" already has connection
+        information defined in itself (which would be the case for a Schema
+        defined by DBIx::Class::Schema::Loader, for instance).
+
     storage_type
         Allows the use of a different "storage_type" than what is set in
         your "schema_class" (which in turn defaults to "::DBI" if not set in
-        current DBIx::Class). Completely optional, and probably unneccesary
-        for most people, until other storage backends become available for
+        current DBIx::Class). Completely optional, and probably unnecessary
+        for most people until other storage backends become available for
         DBIx::Class.
 
 METHODS
     new Instantiates the Model based on the above-documented ->config
-        parameters.
+        parameters. The only required parameter is "schema_class".
+        "connect_info" is required in the case that "schema_class" does not
+        already have connection information defined for it.
 
     schema
         Accessor which returns the connected schema being used by the this
-        model.
+        model. There are already direct shortcuts on the model class itself
+        for schema->resultset, schema->source, and schema->class.
 
     composed_schema
         Accessor which returns the composed schema, which has no connection
         info, which was used in constructing the "schema" above. Useful for
-        creating new connections based on the same schema/model.
+        creating new connections based on the same schema/model. There are
+        direct shortcuts from the model object for composed_schema->clone
+        and composed_schema->connect
 
     clone
         Shortcut for ->composed_schema->clone
@@ -84,8 +102,30 @@ METHODS
     connect
         Shortcut for ->composed_schema->connect
 
+    source
+        Shortcut for ->schema->source
+
+    class
+        Shortcut for ->schema->class
+
+    resultset
+        Shortcut for ->schema->resultset
+
+    storage
+        Provides an accessor for the connected schema's storage object. Used
+        often for debugging and controlling transactions.
+
 SEE ALSO
-    Catalyst, DBIx::Class, DBIx::Class::Schema, DBIx::Class::Schema::Loader
+    General Catalyst Stuff:
+
+    Catalyst::Manual, Catalyst::Test, Catalyst::Request, Catalyst::Response,
+    Catalyst::Helper, Catalyst,
+
+    Stuff related to DBIC and this Model style:
+
+    DBIx::Class, DBIx::Class::Schema, DBIx::Class::Schema::Loader,
+    Catalyst::Helper::Model::DBIC::Schema,
+    Catalyst::Helper::Model::DBIC::SchemaLoader
 
 AUTHOR
     Brandon L Black, "blblack@gmail.com"