Skip to content
Browse files

Updated README to include project background and goals

  • Loading branch information...
1 parent 066d429 commit f6fe86a3144b41089469cdfc1c8e9a8cba4658e0 @katzgrau committed Jun 23, 2010
Showing with 73 additions and 3 deletions.
  1. +73 −3 README.markdown
View
76 README.markdown
@@ -1,7 +1,77 @@
# KLogger: A Simple Logging Class For PHP
-A project written by Kenny Katzgrau and originally hosted at (CodeFury.net)[http://codefury.net)
+A project written by Kenny Katzgrau and originally hosted at
+[CodeFury.net](http://codefury.net/projects/klogger/). This marks the
+development of a newer version of KLogger.
-## Documentation
+## About
-For the documentation to this release, check out: http://codefury.net/projects/klogger/
+KLogger is an easy-to-use logging class for PHP. It supports standard log levels
+like debug, info, warn, error, and fatal. Additionally, it isn't naive about
+file permissions (which is expected). It was meant to be a class that you could
+quickly include into a project and have working right away.
+
+The class was written in 2008, but I have since received a number of emails both
+say 'thanks' and asking me to add features.
+
+This github project will host the development of the next version of KLogger.
+The original version of KLogger is tagged as version 0.1, and is available for
+download [here](http://github.com/katzgrau/KLogger/downloads).
+
+## Goals
+
+KLogger's API will change for the better for it's 1.0 release. Expected changes
+include:
+
+ * Adherence to the Zend Coding Standards for PHP (right now, KLogger has a
+ .NET-ish member and method naming convention). The names of private
+ methods will be prefixed with '_' and camel-cased, for example.
+ * The implementation of a singleton pattern. A logger is likely needed in
+ many parts of an application — there should be no need to instantiate
+ multiple instances. You'll probably see: `$log = KLogger::instance();` in
+ the near future.
+ * Implementation of rolling log files. I've debated whether log files should
+ based on simply the date, or both the date size of the log file. I'm
+ thinking just the date will be sufficient to start.
+ * Put KLogger under a specific license (which will happen below)
+ * Have a bit more encapsulation of class members (and erase my cheeky
+ comments about not having encapsulation)
+
+## Why use KLogger?
+
+Why not? Just drop it in and go. If it saves you time and does what you need,
+go for it! Take a line from the book of our C-code fathers: "`build` upon the
+work of others".
+
+## Who uses KLogger?
+
+Klogger has been used in projects at:
+
+ * The University of Iowa
+ * The University of Laverne
+ * The New Jersey Institute of Technology
+ * Middlesex Hospital in NJ
+
+Additionally, it's been used in numerous projects, both commercial and personal.
+
+## License
+
+Copyright (c) 2008-2010 Kenny Katzgrau <katzgrau@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

0 comments on commit f6fe86a

Please sign in to comment.
Something went wrong with that request. Please try again.