First commit.

2010-01-17 12:08:28 +11:00
commit a95c015633
21 changed files with 3628 additions and 0 deletions
@@ -0,0 +1,56 @@
+# log4js-node
+
+This is a conversion of the [log4js](http://log4js.berlios.de/index.html) 
+framework to work with [node](http://nodejs.org). I've mainly stripped out the browser-specific code
+and tidied up some of the javascript.
+
+## tests
+
+Run the tests with `node tests.js`. They use the awesome [jspec](http://visionmedia.github.com/jspec) - 3.1.3
+
+## usage
+
+See example.js:
+
+  var log4js = require('log4js-node');
+  log4js.addAppender(consoleAppender());
+  log4js.addAppender(fileAppender('logs/cheese.log'), 'cheese');
+  
+  var logger = log4js.getLogger('cheese');
+  logger.setLevel('ERROR');
+  
+  logger.trace('Entering cheese testing');
+  logger.debug('Got cheese.');
+  logger.info('Cheese is Gouda.');  
+  logger.warn('Cheese is quite smelly.');
+  logger.error('Cheese is too ripe!');
+  logger.fatal('Cheese was breeding ground for listeria.');
+  
+Output
+  \[2010-01-17 11:43:37.987\] \[ERROR\] cheese - Cheese is too ripe!
+  \[2010-01-17 11:43:37.990\] \[FATAL\] cheese - Cheese was breeding ground for listeria.
+
+  
+## configuration
+
+You can either configure the appenders and log levels manually (as above), or provide a 
+configuration file (`log4js.configure('path/to/file.json')`). An example file can be found
+in spec/fixtures/log4js.json
+
+## todo
+
+I need to make a RollingFileAppender, which will do log rotation.
+
+patternLayout has no tests. This is mainly because I haven't found a use for it yet, 
+and am not entirely sure what it was supposed to do. It is more-or-less intact from 
+the original log4js.
+
+## author (of this node version)
+
+Gareth Jones (csausdev - gareth.jones@sensis.com.au)
+
+## License
+
+The original log4js was distributed under the Apache 2.0 License, and so is this. I've tried to
+keep the original copyright and author credits in place, except in sections that I have rewritten 
+extensively.