Permalink
Browse files

adding readme

  • Loading branch information...
1 parent 058a437 commit 293fb3beb1ba2de33da9a257f43b8fc0d8335a97 @tmaiaroto committed Jan 2, 2012
Showing with 18 additions and 0 deletions.
  1. +18 −0 README
View
18 README
@@ -0,0 +1,18 @@
+The li3_perf library provides a toolbar for your Lithium application
+useful for debugging. Various performance factors are displayed in this
+toolbar including time to load, database query explains, and more.
+The Lithium log files (within resources/tmp/logs) are also displayed
+in this toolbar.
+
+Note: It is suggested that you have a program called "ccze" installed
+on your machine. While not required, it makes the log output colored
+and formatted with HTML. Otherwise, it will just be one color.
+
+Also Note: You must have a newer version of Lithium. There was
+a change to the lithium/data/collection class. An additional method
+was added so that the $this->_result could be returned. This property
+contains the MongoCursor, which is required to display the explain()
+for Mongo queries.
+
+
+

0 comments on commit 293fb3b

Please sign in to comment.