update readme on usage

asmega · Jul 21, 2012 · dfef9a6 · dfef9a6
1 parent e23d738
commit dfef9a6
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,7 +22,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Inside you rails app. Add the following line to config/development.rb and/or any other environment you wish to use this in.
+
+    config.middleware.use(Logput::Middleware)
+
+The following configuration options are available.
+
+* :path_to_log_file => '/path/to/custom/log'. Defaults to current environments log file if in rails.
+* :lines_to_read => 1000. Defaults to 500.
+
+Example.
+
+    config.middleware.use(Logput::Middleware, :lines_to_read => 300, :path_to_log_file => './log/delayed_job')
 
 ## Contributing