about summary refs log tree commit diff
diff options
context:
space:
mode:
authorfranck cuny <franck@lumberjaph.net>2010-02-28 11:14:06 +0100
committerfranck cuny <franck@lumberjaph.net>2010-02-28 11:14:06 +0100
commita7cfe548cb8d4be60c654681165318639890a3fc (patch)
treefa862681432f59a9f3a4a749c3a2d7a5bbf2b047
parentbasic tests (diff)
downloadplack-middleware-etag-a7cfe548cb8d4be60c654681165318639890a3fc.tar.gz
update readme and makefile
-rw-r--r--Makefile.PL6
-rw-r--r--README37
2 files changed, 21 insertions, 22 deletions
diff --git a/Makefile.PL b/Makefile.PL
index 0b8aa8d..81394cb 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -2,11 +2,15 @@ use inc::Module::Install;
 name 'Plack-Middleware-ETag';
 all_from 'lib/Plack/Middleware/ETag.pm';
 
-# requires '';
+requires 'Plack';
+requires 'Digest::SHA';
+requires 'HTTP::Request::Common';
 
 tests 't/*.t';
 author_tests 'xt';
 
+readme_from 'lib/Plack/Middleware/ETag.pm';
+
 build_requires 'Test::More';
 use_test_base;
 auto_include;
diff --git a/README b/README
index f6778a6..dd680e0 100644
--- a/README
+++ b/README
@@ -1,27 +1,22 @@
-This is Perl module Plack::Middleware::ETag.
+NAME
+    Plack::Middleware::ETag - Adds automatically an ETag header.
 
-INSTALLATION
+SYNOPSIS
+      use Plack::Builder;
 
-Plack::Middleware::ETag installation is straightforward. If your CPAN shell is set up,
-you should just be able to do
+      my $app = builder {
+        enable "Plack::Middleware::ETag";
+        sub {['200', ['Content-Type' => 'text/html'}, ['hello world']]};
+      };
 
-    % cpan Plack::Middleware::ETag
+DESCRIPTION
+    Plack::Middleware::ETag adds automatically an ETag header.
 
-Download it, unpack it, then build it as per the usual:
+AUTHOR
+    franck cuny <franck@lumberjaph.net>
 
-    % perl Makefile.PL
-    % make && make test
+SEE ALSO
+LICENSE
+    This library is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself.
 
-Then install it:
-
-    % make install
-
-DOCUMENTATION
-
-Plack::Middleware::ETag documentation is available as in POD. So you can do:
-
-    % perldoc Plack::Middleware::ETag
-
-to read the documentation online with your favorite pager.
-
-franck cuny