X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=e6b6ecd3a49ee4eafea00713703a46aba12c3bc6;hb=5f6b10785120ed3d49217285bcfa5ca43006e466;hp=3a7f64afe55a1f353baaf5e26985c5be33a7fb16;hpb=cbf59b953cb1192aef400bf60dbc22ae78b80f1d;p=dbsrgits%2FDBIx-Class-UUIDColumns.git

diff --git a/README b/README
index 3a7f64a..e6b6ecd 100644
--- a/README
+++ b/README
@@ -2,9 +2,12 @@ NAME
     DBIx::Class::UUIDColumns - Implicit uuid columns
 
 SYNOPSIS
-      package Artist;
-      __PACKAGE__->load_components(qw/UUIDColumns Core DB/);
-      __PACKAGE__->uuid_columns( 'artist_id' );
+    In your DBIx::Class table class:
+
+      __PACKAGE__->load_components(qw/UUIDColumns ... Core/);
+      __PACKAGE__->uuid_columns('artist_id');
+
+    Note: The component needs to be loaded *before* Core.
 
 DESCRIPTION
     This DBIx::Class component resembles the behaviour of Class::DBI::UUID,
@@ -29,28 +32,33 @@ DESCRIPTION
       __PACKAGE__->uuid_class('::Data::UUID');
       __PACKAGE__->uuid_class('MyUUIDGenerator');
 
-    Note that the component needs to be loaded before Core.
-
 METHODS
-  uuid_columns(@columns)
+  get_uuid
+    Returns a uuid string from the current uuid_maker.
+
+  insert
+    Inserts a new uuid string into each column in "uuid_columns".
+
+  uuid_columns
     Takes a list of columns to be filled with uuids during insert.
 
-      __PACKAGE__->uuid_columns('id');
+      __PACKAGE__->uuid_columns('artist_id');
 
-  uuid_class($classname)
+  uuid_class
     Takes the name of a UUIDMaker subclass to be used for uuid value
     generation. This can be a fully qualified class name, or a shortcut name
     starting with :: that matches one of the available
-    DBIx::Class::UUIDMaker subclasses:
+    DBIx::Class::UUIDColumns::UUIDMaker subclasses:
 
       __PACKAGE__->uuid_class('CustomUUIDGenerator');
       # loads CustomeUUIDGenerator
 
-      __PACKAGE->uuid_class('::Data::UUID');
+      __PACKAGE__->uuid_class('::Data::UUID');
       # loads DBIx::Class::UUIDMaker::Data::UUID;
 
     Note that "uuid_class" chacks to see that the specified class isa
-    DBIx::Class::UUIDMaker subbclass and throws and exception if it isn't.
+    DBIx::Class::UUIDColumns::UUIDMaker subbclass and throws and exception
+    if it isn't.
 
   uuid_maker
     Returns the current UUIDMaker instance for the given module.
@@ -58,10 +66,13 @@ METHODS
       my $uuid = __PACKAGE__->uuid_maker->as_string;
 
 SEE ALSO
-    DBIx::Class::UUIDMaker
+    DBIx::Class::UUIDColumns::UUIDMaker
+
+AUTHOR
+    Chia-liang Kao <clkao@clkao.org>
 
-AUTHORS
-    Chia-liang Kao <clkao@clkao.org> Chris Laco <claco@chrislaco.com>
+CONTRIBUTERS
+    Chris Laco <claco@chrislaco.com>
 
 LICENSE
     You may distribute this code under the same terms as Perl itself.