Add Usage

Author: wangxz

.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *~
+nbproject/*

README.md

@@ -1,24 +1,32 @@
 # Limiter
 
-TODO: Write a gem description
+Rack middleware for rate-limiting incoming HTTP requests with black_list and white_list support.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'limiter'
+    gem 'limiter', :git => "git://github.com/csdn-dev/limiter.git"
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install limiter
-
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# config/initializers/limiter.rb
+require File.expand_path("../redis", __FILE__)
+Rails.configuration.app_middleware.insert_before(Rack::MethodOverride,
+                                                 Limiter::RateLimiter,
+                                                 :black_list => Limiter::BlackList.new($redis),
+                                                 :white_list => Limiter::WhiteList.new($redis),
+                                                 :allow_path => Rails.env.development? ? /^\/(assets|human_validations|simple_captcha)/ :
+                                                                                         /^\/(human_validations|simple_captcha)/,
+                                                 :message => "<a href='/human_validations/new'>我不是机器人</a>",
+                                                 :visit_counter => Limiter::VisitCounter.new($redis)
+                                                )
+```
 
 ## Contributing
 

lib/limiter/base.rb

@@ -113,8 +113,8 @@ def rate_limit_exceeded
     # @param  [Hash{String => String}] headers
     # @return [Array(Integer, Hash, #each)]
     def http_error(code, message = nil, headers = {})
-      [code, {'Content-Type' => 'text/plain; charset=utf-8'}.merge(headers),
-        http_status(code) + (message.nil? ? "\n" : " (#{message})\n")]
+      [code, {'Content-Type' => 'text/html; charset=utf-8'}.merge(headers),
+        [http_status(code) + (message.nil? ? "\n" : " (#{message})\n")]]
     end
 
     ##

lib/limiter/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Limiter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end