Add a Synopsis based on the tests
Chris Prather [Tue, 29 Apr 2008 19:03:08 +0000 (19:03 +0000)]
lib/MooseX/MetaDescription.pm

index b4e681d..c848df4 100644 (file)
@@ -20,7 +20,26 @@ MooseX::MetaDescription - A framework for adding additional metadata to Moose cl
 
 =head1 SYNOPSIS
 
-  use MooseX::MetaDescription;
+    package Foo;
+    use metaclass 'MooseX::MetaDescription::Meta::Class';
+    use Moose;
+
+    __PACKAGE__->meta->description->{'Hello'} = 'World';
+
+    has 'bar' => (
+        metaclass   => 'MooseX::MetaDescription::Meta::Attribute',
+        is          => 'ro',
+        isa         => 'Str',   
+        default     => sub { 'Foo::bar' },
+        description => {
+            baz   => 'Foo::bar::baz',
+        }
+    );
+
+    ...
+    
+    $foo->meta->description; # { 'Hello' => 'World' }
+    $foo->meta->get_attribute('bar')->description; # { baz   => 'Foo::bar::baz' }    
 
 =head1 DESCRIPTION