update Changes

[gitmo/MooseX-Types-Common.git] / README

diff --git a/README b/README
index a0afb3d..f8ceb71 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,49 @@
-perl Makefile.PL
-make
-make test
-sudo make install
-make clean
\ No newline at end of file
+NAME
+    MooseX::Types::Common - A library of commonly used type constraints
+
+SYNOPSIS
+        use MooseX::Types::Common::String qw/SimpleStr/;
+        has short_str => (is => 'rw', isa => SimpleStr);
+
+        ...
+        #this will fail
+        $object->short_str("string\nwith\nbreaks");
+
+
+
+        use MooseX::Types::Common::Numeric qw/PositiveInt/;
+        has count => (is => 'rw', isa => PositiveInt);
+
+        ...
+        #this will fail
+        $object->count(-33);
+
+DESCRIPTION
+    A set of commonly-used type constraints that do not ship with Moose by
+    default.
+
+SEE ALSO
+    *   MooseX::Types::Common::String
+
+    *   MooseX::Types::Common::Numeric
+
+    *   MooseX::Types
+
+    *   Moose::Util::TypeConstraints
+
+AUTHORS
+    This distribution was extracted from the Reaction code base by Guillermo
+    Roditi (groditi).
+
+    The original authors of this library are:
+
+    *   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.
+