Updated props

[dbsrgits/DBIx-Class-UUIDColumns.git] / README

diff --git a/README b/README
index 292a405..80aacf0 100644 (file)
--- a/README
+++ b/README
@@ -1,79 +1,79 @@
-NAME\r
-    DBIx::Class::UUIDColumns - Implicit uuid columns\r
-\r
-SYNOPSIS\r
-    In your DBIx::Class table class:\r
-\r
-      __PACKAGE__->load_components(qw/UUIDColumns ... Core/);\r
-      __PACKAGE__->uuid_columns('artist_id');\r
-\r
-    Note: The component needs to be loaded *before* Core.\r
-\r
-DESCRIPTION\r
-    This DBIx::Class component resembles the behaviour of Class::DBI::UUID,\r
-    to make some columns implicitly created as uuid.\r
-\r
-    When loaded, "UUIDColumns" will search for a suitable uuid generation\r
-    module from the following list of supported modules:\r
-\r
-      Data::UUID\r
-      APR::UUID*\r
-      UUID\r
-      Win32::Guidgen\r
-      Win32API::GUID\r
-\r
-    If no supporting module can be found, an exception will be thrown.\r
-\r
-    *APR::UUID will not be loaded under OpenBSD due to an as yet\r
-    unidentified XS issue.\r
-\r
-    If you would like to use a specific module, you can set "uuid_class":\r
-\r
-      __PACKAGE__->uuid_class('::Data::UUID');\r
-      __PACKAGE__->uuid_class('MyUUIDGenerator');\r
-\r
-METHODS\r
-  get_uuid\r
-    Returns a uuid string from the current uuid_maker.\r
-\r
-  insert\r
-    Inserts a new uuid string into each column in "uuid_columns".\r
-\r
-  uuid_columns\r
-    Takes a list of columns to be filled with uuids during insert.\r
-\r
-      __PACKAGE__->uuid_columns('artist_id');\r
-\r
-  uuid_class\r
-    Takes the name of a UUIDMaker subclass to be used for uuid value\r
-    generation. This can be a fully qualified class name, or a shortcut name\r
-    starting with :: that matches one of the available\r
-    DBIx::Class::UUIDColumns::UUIDMaker subclasses:\r
-\r
-      __PACKAGE__->uuid_class('CustomUUIDGenerator');\r
-      # loads CustomeUUIDGenerator\r
-\r
-      __PACKAGE__->uuid_class('::Data::UUID');\r
-      # loads DBIx::Class::UUIDMaker::Data::UUID;\r
-\r
-    Note that "uuid_class" checks to see that the specified class isa\r
-    DBIx::Class::UUIDColumns::UUIDMaker subclass and throws and exception if\r
-    it isn't.\r
-\r
-  uuid_maker\r
-    Returns the current UUIDMaker instance for the given module.\r
-\r
-      my $uuid = __PACKAGE__->uuid_maker->as_string;\r
-\r
-SEE ALSO\r
-    DBIx::Class::UUIDColumns::UUIDMaker\r
-\r
-AUTHOR\r
-    Chia-liang Kao <clkao@clkao.org>\r
-\r
-CONTRIBUTERS\r
-    Chris Laco <claco@chrislaco.com>\r
-\r
-LICENSE\r
-    You may distribute this code under the same terms as Perl itself.\r
-\r
+NAME
+    DBIx::Class::UUIDColumns - Implicit uuid columns
+
+SYNOPSIS
+    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,
+    to make some columns implicitly created as uuid.
+
+    When loaded, "UUIDColumns" will search for a suitable uuid generation
+    module from the following list of supported modules:
+
+      Data::UUID
+      APR::UUID*
+      UUID
+      Win32::Guidgen
+      Win32API::GUID
+
+    If no supporting module can be found, an exception will be thrown.
+
+    *APR::UUID will not be loaded under OpenBSD due to an as yet
+    unidentified XS issue.
+
+    If you would like to use a specific module, you can set "uuid_class":
+
+      __PACKAGE__->uuid_class('::Data::UUID');
+      __PACKAGE__->uuid_class('MyUUIDGenerator');
+
+METHODS
+  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('artist_id');
+
+  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::UUIDColumns::UUIDMaker subclasses:
+
+      __PACKAGE__->uuid_class('CustomUUIDGenerator');
+      # loads CustomeUUIDGenerator
+
+      __PACKAGE__->uuid_class('::Data::UUID');
+      # loads DBIx::Class::UUIDMaker::Data::UUID;
+
+    Note that "uuid_class" checks to see that the specified class isa
+    DBIx::Class::UUIDColumns::UUIDMaker subclass and throws and exception if
+    it isn't.
+
+  uuid_maker
+    Returns the current UUIDMaker instance for the given module.
+
+      my $uuid = __PACKAGE__->uuid_maker->as_string;
+
+SEE ALSO
+    DBIx::Class::UUIDColumns::UUIDMaker
+
+AUTHOR
+    Chia-liang Kao <clkao@clkao.org>
+
+CONTRIBUTERS
+    Chris Laco <claco@chrislaco.com>
+
+LICENSE
+    You may distribute this code under the same terms as Perl itself.
+