Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Adding readme for GitHub

  • Loading branch information...
commit ee18978c5eebdcd50dac567cd5e95b28eace31d9 1 parent 7a57ad0
Robbie Hanson robbiehanson authored
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.markdown
34 README.markdown
View
@@ -0,0 +1,34 @@
+### Lumberjack is Fast & Simple, yet Powerful & Flexible.
+
+It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for objective-c, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the objective-c runtime.
+
+### Lumberjack is Fast
+
+In most cases it is an order of magnitude faster than NSLog.
+
+### Lumberjack is Simple
+
+It takes as little as a single line of code to configure lumberjack when your application launches. Then simply replace your NSLog statements with DDLog statements and that's about it. (And the DDLog macros have the exact same format and syntax as NSLog, so it's super easy.)
+
+### Lumberjack is Powerful:
+
+One log statement can be sent to multiple loggers, meaning you can log to a file and the console simultaneously. Want more? Create your own loggers (it's easy) and send your log statements over the network. Or to a database or distributed file system. The sky is the limit.
+
+### Lumberjack is Flexible:
+
+Configure your logging however you want. Change log levels per file (perfect for debugging). Change log levels per logger (verbose console, but concise log file). Change log levels per xcode configuration (verbose debug, but concise release). Have your log statements compiled out of the release build. Customize the number of log levels for your application. Add your own fine-grained logging. Dynamically change log levels during runtime. Choose how & when you want your log files to be rolled. Upload your log files to a central server. Compress archived log files to save disk space...
+
+<br/>
+This framework is for you if:
+
+- You're looking for a way to track down that impossible-to-reproduce bug that keeps popping up in the field.
+- You're frustrated with the super short console log on the iPhone.
+- You're looking to take your application to the next level in terms of support and stability.
+- You're looking for an enterprise level logging solution for your application (Mac or iPhone).
+
+<br/>
+**[Get started using the Cocoa Lumberjack Framework](https://github.com/robbiehanson/CocoaLumberjack/wiki/GettingStarted)**
+
+<br/>
+<br/>
+Love the project? Wanna buy me a coffee? (or a beer :D) [![donation](http://www.paypal.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RW6R9U4ZWWZ8C)
Please sign in to comment.
Something went wrong with that request. Please try again.