1 files changed, 26 insertions, 0 deletions
diff --git a/README.rdoc b/README.rdoc
new file mode 100644
index 0000000..933918a
--- /dev/null
+++ b/README.rdoc
@@ -0,0 +1,26 @@
+== Mixlib::Logger
+
+Mixlib::Logger provides a mixin for enabling a class based logger object, a-la Merb, Chef, and Nanite.  To use it:
+
+	require 'mixlib/logger'
+	
+	class Log
+		class << self
+			include 'mixlib/logger'
+		end
+	end
+	
+You can then do:
+
+	Log.debug("foo")
+	Log.info("bar")
+	Log.warn("baz")
+	Log.error("baz")
+	Log.fatal("wewt")
+	
+By default, Mixlib::Logger logs to STDOUT.  To alter this, you should call Log.init, passing any arguments to the standard Ruby Logger.  For example:
+
+	Log.init("/tmp/logfile")    # log to /tmp/logfile
+	Log.init("/tmp/logfile", 7) # log to /tmp/logfile, rotate every day
+	
+Enjoy!