more tweaks for 0.01

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

diff --git a/lib/MooseX/Storage/Format/JSON.pm b/lib/MooseX/Storage/Format/JSON.pm
index 47d59ec..938b5c7 100644 (file)
--- a/lib/MooseX/Storage/Format/JSON.pm
+++ b/lib/MooseX/Storage/Format/JSON.pm
@@ -4,6 +4,8 @@ use Moose::Role;
 
 use JSON::Any;
 
+our $VERSION = '0.01';
+
 requires 'pack';
 requires 'unpack';
 
@@ -29,7 +31,28 @@ MooseX::Storage::Format::JSON
 
 =head1 SYNOPSIS
 
-=head1 DESCRIPTION
+  package Point;
+  use Moose;
+  use MooseX::Storage;
+  
+  with Storage('format' => 'JSON');
+  
+  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 JSON)
+  
+  # pack the class into a JSON string
+  $p->freeze(); # { "__CLASS__" : "Point", "x" : 10, "y" : 10 }
+  
+  # unpack the JSON string into a class
+  my $p2 = Point->thaw('{ "__CLASS__" : "Point", "x" : 10, "y" : 10 }');  
 
 =head1 METHODS