initial commit

1 files changed, 27 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..722437a
--- /dev/null
+++ b/README
@@ -0,0 +1,27 @@
+This is Perl module Plack::Middleware::APIRateLimit.
+
+INSTALLATION
+
+Plack::Middleware::APIRateLimit installation is straightforward. If your CPAN shell is set up,
+you should just be able to do
+
+    % cpan Plack::Middleware::APIRateLimit
+
+Download it, unpack it, then build it as per the usual:
+
+    % perl Makefile.PL
+    % make && make test
+
+Then install it:
+
+    % make install
+
+DOCUMENTATION
+
+Plack::Middleware::APIRateLimit documentation is available as in POD. So you can do:
+
+    % perldoc Plack::Middleware::APIRateLimit
+
+to read the documentation online with your favorite pager.
+
+franck cuny