README.md in fluent-plugin-twitter-0.0.1 vs README.md in fluent-plugin-twitter-0.1.1

@@ -1,10 +1,10 @@
 fluent-plugin-twitter
 =====================
 
-## Overview
-create your own twitter bot with fluentd
+## Component
+Fluentd Input/Output plugin. You can create your own "Twitter Bot" with fluentd messaging system.
 
 ## Installation
 
 ### native gem
 
@@ -15,24 +15,69 @@
 ### td-agent gem
 `````
 /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-twitter
 `````
 
-## Configuration
+## Input Configuration
 
-### Sample
+### Input Sample
 `````
+<source>
+  type twitter
+  consumer_key        YOUR_CONSUMER_KEY       # Required
+  consumer_secret     YOUR_CONSUMER_SECRET    # Required
+  oauth_token         YOUR_OAUTH_TOKEN        # Required
+  oauth_token_secret  YOUR_OAUTH_TOKEN_SECRET # Required
+  tag                 input.twitter.sampling  # Required
+  timeline            sampling                # Required (sampling or userstream)
+  keyword             Ruby,Python             # Optional (userstream not supported yet)
+  lang                ja,en                   # Optional
+</source>
+
+<match input.twitter.sampling>
+  type stdout
+</match>
+`````
+
+### Debug
+`````
+$ tail -f /var/log/td-agent/td-agent.log
+`````
+
+## Output Configuration
+
+### Output Sample
+`````
+<source>
+  type http
+  port 8888
+</source>
+
 <match notify.twitter>
   type twitter
   consumer_key        YOUR_CONSUMER_KEY
   consumer_secret     YOUR_CONSUMER_SECRET
-  oauth_token         YOUR_OAUTH_TOEKN
-  oauth_token_secret  YOUR_OAUTH_TOEKN_SECRET
+  oauth_token         YOUR_OAUTH_TOKEN
+  oauth_token_secret  YOUR_OAUTH_TOKEN_SECRET
 </match>
 `````
 
+### Debug
+`````
+$ curl http://localhost:8888/notify.twitter -F 'json={"message":"foo"}'
+`````
+
+## Reference
+
+### Twitter OAuth Guide
+http://pocketstudio.jp/log3/2012/02/12/how_to_get_twitter_apikey_and_token/
+
 ## TODO
 patches welcome!
+
+## Known Issue
+On starting fluentd, appearing alert message below. Please tell me how to fix up.
+`/usr/lib64/fluent/ruby/lib/ruby/gems/1.9.1/gems/eventmachine-1.0.0/lib/eventmachine.rb:1530: warning: already initialized constant EM`
 
 ## Copyright
 
 Copyright © 2012- Kentaro Yoshida (@yoshi_ken)