1 files changed, 41 insertions, 0 deletions
diff --git a/lib/Plack/Middleware/Throttle/Hourly.pm b/lib/Plack/Middleware/Throttle/Hourly.pm
index 818d70b..84b3d6d 100644
--- a/lib/Plack/Middleware/Throttle/Hourly.pm
+++ b/lib/Plack/Middleware/Throttle/Hourly.pm
@@ -15,3 +15,44 @@ sub reset_time {
 }
 
 1;
+__END__
+
+=head1 NAME
+
+Plack::Middleware::Throttle::Hourly - A Plack Middleware for rate-limiting incoming HTTP requests.
+
+=head1 SYNOPSIS
+
+  my $handler = builder {
+    enable "Throttle::Hourly",
+        max     => 2,
+        backend => Plack::Middleware::Throttle::Backend::Hash->new();
+    sub { [ '200', [ 'Content-Type' => 'text/html' ], ['hello world'] ] };
+  };
+
+=head1 DESCRIPTION
+
+How many request an host can do in one hour.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<max>
+
+How many requets can be done in one hour.
+
+=back
+
+=head1 AUTHOR
+
+franck cuny E<lt>franck@lumberjaph.netE<gt>
+
+=head1 SEE ALSO
+
+=head1 LICENSE
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut