README.md in klogger-1.0.0 vs README.md in klogger-1.0.1

@@ -1,4 +1,43 @@
+[![Build Status](https://travis-ci.org/killbill/killbill-logging-plugin.png)](https://travis-ci.org/killbill/killbill-logging-plugin)
+[![Code Climate](https://codeclimate.com/github/killbill/killbill-logging-plugin.png)](https://codeclimate.com/github/killbill/killbill-logging-plugin)
+
 killbill-logging-plugin
 =======================
 
-Plugin to log Killbill events
\ No newline at end of file
+Plugin to log Kill Bill events.
+
+Configuration
+-------------
+
+The plugin expects a `klogger.yml` configuration file containing the following:
+
+```
+syslog:
+  :enabled: true
+  :ident: 'klogger'
+  :options: 9 # ::Syslog::LOG_PID | ::Syslog::LOG_NDELAY
+  :facility: 128 # ::Syslog::LOG_LOCAL0
+
+irc:
+  :enabled: true
+  :channels: ['#killbilling']
+  :nick: 'klogger'
+  :server: 'irc.freenode.org'
+  :port: 6667
+  :password: 'foo'
+
+email:
+  :to: [e-mail]
+  :from: [e-mail]
+  :enabled: true
+  :address: 'smtp.gmail.com'
+  :port: 587
+  :domain: 'your.host.name'
+  :username: 'username'
+  :password: 'password'
+  :authentication: 'plain'
+  :enable_starttls_auto: true
+```
+
+By default, the plugin will look at the plugin directory root (where `killbill.properties` is located) to find this file.
+Alternatively, set the Kill Bill system property `-Dcom.ning.billing.osgi.bundles.jruby.conf.dir=/my/directory` to specify another location.