update README (pod2text)
Justin Hunter [Tue, 6 Dec 2011 04:27:15 +0000 (23:27 -0500)]
README

diff --git a/README b/README
index 06f6761..f8ceb71 100644 (file)
--- a/README
+++ b/README
@@ -1,38 +1,49 @@
-MooseX::Types::Common - A library of commonly used type constraints.
+NAME
+    MooseX::Types::Common - A library of commonly used type constraints
 
-INSTALLATION
+SYNOPSIS
+        use MooseX::Types::Common::String qw/SimpleStr/;
+        has short_str => (is => 'rw', isa => SimpleStr);
 
-To install this module, run the following commands:
+        ...
+        #this will fail
+        $object->short_str("string\nwith\nbreaks");
 
-  perl Makefile.PL
-  make
-  make test
-  make install
 
-SUPPORT AND DOCUMENTATION
 
-After installing, you can find documentation for this module with the
-perldoc command.
+        use MooseX::Types::Common::Numeric qw/PositiveInt/;
+        has count => (is => 'rw', isa => PositiveInt);
 
-    perldoc MooseX::Types:Common
+        ...
+        #this will fail
+        $object->count(-33);
 
-You can also look for information at:
+DESCRIPTION
+    A set of commonly-used type constraints that do not ship with Moose by
+    default.
 
-    RT, CPAN's request tracker
-        http://rt.cpan.org/NoAuth/Bugs.html?Dist=MooseX-Types-Common
+SEE ALSO
+    *   MooseX::Types::Common::String
 
-    AnnoCPAN, Annotated CPAN documentation
-        http://annocpan.org/dist/MooseX-Types-Common
+    *   MooseX::Types::Common::Numeric
 
-    CPAN Ratings
-        http://cpanratings.perl.org/d/MooseX-Types-Common
+    *   MooseX::Types
 
-    Search CPAN
-        http://search.cpan.org/dist/MooseX-Types-Common
+    *   Moose::Util::TypeConstraints
 
+AUTHORS
+    This distribution was extracted from the Reaction code base by Guillermo
+    Roditi (groditi).
 
-LICENCE
+    The original authors of this library are:
 
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
+    *   Matt S. Trout
+
+    *   K. J. Cheetham
+
+    *   Guillermo Roditi
+
+LICENSE
+    This library is free software, you can redistribute it and/or modify it
+    under the same terms as Perl itself.