docs

[gitmo/MooseX-Storage.git] / lib / MooseX / Storage / Format / YAML.pm

diff --git a/lib/MooseX/Storage/Format/YAML.pm b/lib/MooseX/Storage/Format/YAML.pm
index 08525e9..d7ccb06 100644 (file)
--- a/lib/MooseX/Storage/Format/YAML.pm
+++ b/lib/MooseX/Storage/Format/YAML.pm
@@ -32,6 +32,39 @@ MooseX::Storage::Format::YAML
 
 =head1 SYNOPSIS
 
+  package Point;
+  use Moose;
+  use MooseX::Storage;
+  
+  with Storage('format' => 'YAML');
+  
+  has 'x' => (is => 'rw', isa => 'Int');
+  has 'y' => (is => 'rw', isa => 'Int');
+  
+  1;
+  
+  my $p = Point->new(x => 10, y => 10);
+  
+  ## methods to freeze/thaw into 
+  ## a specified serialization format
+  ## (in this case YAML)
+  
+  # pack the class into a YAML string
+  $p->freeze(); 
+
+  # ----
+  # __CLASS__: "Point" 
+  # x: 10
+  # y: 10  
+  
+  # unpack the JSON string into a class
+  my $p2 = Point->thaw(<<YAML);  
+  ----
+  __CLASS__: "Point" 
+  x: 10
+  y: 10
+  YAML
+  
 =head1 DESCRIPTION
 
 =head1 METHODS
@@ -40,7 +73,7 @@ MooseX::Storage::Format::YAML
 
 =item B<freeze>
 
-=item B<thaw ($json)>
+=item B<thaw ($yaml)>
 
 =back