[Catalyst-commits] r9521 - Catalyst-Plugin-Compress/0.001/lib/Catalyst/Plugin

[xinming at dev.catalyst.perl.org]

Author: xinming
Date: 2009-03-18 17:30:27 +0000 (Wed, 18 Mar 2009)
New Revision: 9521

Modified:
   Catalyst-Plugin-Compress/0.001/lib/Catalyst/Plugin/Compress.pm
Log:
Pod update for Catalyst-Plugin-Compress

Modified: Catalyst-Plugin-Compress/0.001/lib/Catalyst/Plugin/Compress.pm
===================================================================
--- Catalyst-Plugin-Compress/0.001/lib/Catalyst/Plugin/Compress.pm	2009-03-18 16:34:44 UTC (rev 9520)
+++ Catalyst-Plugin-Compress/0.001/lib/Catalyst/Plugin/Compress.pm	2009-03-18 17:30:27 UTC (rev 9521)
@@ -114,26 +114,30 @@
         Compress
     /;
 
-If you want use this plugin with L<Catalyst::Plugin::Unicode>.
+If you want to use this plugin with L<Catalyst::Plugin::Unicode>.
 
-And specify compression format with:
+Remember to specify compression_format with:
 
     __PACKAGE__->config(
         compression_format => $format,
     );
 
-$format can be either gzip bzip2 zlib or deflate.
+$format can be either gzip bzip2 zlib or deflate.  bzip2 is B<*only*> supported
+by lynx and some other console text-browsers.
 
 =head1 DESCRIPTION
 
-Compress response to [gzip bzip2 zlib deflate] if client supports it.
+This module combines L<Catalyst::Plugin::Deflate> L<Catalyst::Plugin::Gzip>
+L<Catalyst::Plugin::Zlib> into one.
 
+It compress response to [gzip bzip2 zlib deflate] if client supports it.
+
 B<NOTE>: If you want to use this module with L<Catalyst::Plugin::Unicode>, You
 B<MUST> load this plugin B<AFTER> L<Catalyst::Plugin::Unicode>.
 
     use Catalyst qw/
         Unicode
-        Compress::Deflate
+        Compress
     /;
 
 If you don't, You'll get error which is like:
@@ -151,7 +155,7 @@
 
 =head1 LICENSE
 
-This library is free software . You can redistribute it and/or modify it under
+This library is free software. You can redistribute it and/or modify it under
 the same terms as perl itself.
 
 =cut