bunch more docs

[catagits/Web-Session.git] / lib / Plack / Session / Store / CHI.pm

diff --git a/lib/Plack/Session/Store/CHI.pm b/lib/Plack/Session/Store/CHI.pm
index 91579ef..1e2956b 100644 (file)
--- a/lib/Plack/Session/Store/CHI.pm
+++ b/lib/Plack/Session/Store/CHI.pm
@@ -53,6 +53,8 @@ sub cleanup {
 
 __END__
 
+=pod
+
 =head1 NAME
 
 Plack::Session::Store::CHI - CHI session store
@@ -68,33 +70,41 @@ Plack::Session::Store::CHI - CHI session store
   };
 
   builder {
-      enable 'Session', store => Plack::Session::Store::CHI->new(chi => CHI->new(driver => 'FastMmap'));
+      enable 'Session',
+          store => Plack::Session::Store::CHI->new(
+              chi => CHI->new(driver => 'FastMmap')
+          );
       $app;
   };
 
-=head1 METHODS
+=head1 DESCRIPTION
 
-=over 4
+This will persist session data using the L<CHI> module. This
+offers a lot of flexibility due to the many excellent L<CHI>
+drivers available.
 
-=item B<new ( %params )>
+This is a subclass of L<Plack::Session::Store> and implements
+it's full interface.
 
-=back
+=head1 METHODS
 
 =over 4
 
-=item B<fetch ( $session_id, $key )>
+=item B<new ( %params )>
 
-=item B<store ( $session_id, $key, $data )>
+The constructor expects an the I<chi> param to be an
+instance of L<CHI::Driver>, it will throw an exception
+if that is not the case.
 
-=item B<delete ( $session_id, $key )>
+=item B<chi>
 
 =back
 
-=over 4
+=head1 BUGS
 
-=item B<cleanup ( $session_id )>
-
-=back
+All complex software has bugs lurking in it, and this module is no
+exception. If you find a bug please either email me, or add the bug
+to cpan-RT.
 
 =head1 AUTHOR