"description":"Unlike many of the libraries out there, Scribe.js allows logging on multiple files and is divided into folders by date. And it is possibly the easiest logging you can implement. And it does everything you need a basic logger to do.",
"readme":"\r\n=======\r\n**Lightweight NodeJS Logging**\r\nOverview\r\n=======\r\nUnlike many of the libraries out there, Scribe.js allows logging on multiple files and is divided into folders by date. And it is possibly the easiest logging you can implement. And it does everything you need a basic logger to do.\r\n- Save messages into log files organized by user, date, and type\r\n- Print messages into console using colors indicating level of importance\r\n\r\nOutput Methods (Web | Console | File)\r\n=======\r\nMethod#Web - Select Date\r\n---\r\n\r\nMethod#Web - Select Log Type\r\n---\r\n\r\nMethod#Web - View Logs\r\n---\r\n\r\nMethod#Console - Command Prompt\r\n---\r\n\r\nMethod#File - File\r\n---\r\n\r\nMethod#File - Directory Layout\r\n---\r\n\r\n\r\nInstallation\r\n=======\r\n```\r\nnpm install git+https://github.com/bluejamesbond/Scribe.js.git\r\n```\r\nDocumentation\r\n=======\r\n```js\r\nvar scribe = require('scribe'); \r\n\r\n// Configuration\r\n// --------------\r\nscribe.configure(function(){\r\n scribe.set('app', 'MY_APP_NAME'); // NOTE Best way learn about these settings is\r\n scribe.set('logPath', './logs'); // Doublecheck // them out for yourself.\r\n scribe.set('defaultTag', 'DEFAULT_TAG');\r\n scribe.set('divider', ':::');\r\n scribe.set('identation', 5); // Identation before console messages\r\n \r\n scribe.set('maxTagLength', 30); // Any tags that have a length greather than\r\n // 30 characters will be ignored\r\n \r\n scribe.set('mainUser', 'root'); // Username of the account which is running\r\n // the NodeJS server\r\n});\r\n\r\n// Create Loggers\r\n// --------------\r\nscribe.addLogger(\"log\", true , true, 'green'); // (name, save to file, print to console,\r\nscribe.addLogger('realtime', true, true, 'underline'); // tag color)\r\nscribe.addLogger('high', true, true, 'magenta');\r\nscribe.addLogger('normal', true, true, 'white');\r\nscribe.addLogger('low', true, true, 'grey');\r\nscribe.addLogger('info', true, true, 'cyan');\r\n\r\n// Express.js\r\n// WARNING: ExpressJS must be installed for this to work\r\n// You also need to start an ExpressJS server in order for\r\n// this to work.\r\n// --------------\r\napp.use(scribe.express.logger(function(req, res){ // Express.js access log\r\n return true; // Filter out any Express messages\r\n}));\r\n\r\n// Control Panel\r\n// WARNING: ExpressJS must be installed for this to work\r\n// You also need to start an ExpressJS server in order for\r\n// this to work.\r\n// --------------\r\napp.get('/log', scribe.express.controlPanel()); // Enable web control panel\r\n\r\n// Basic logging\r\n// --------------\r\nconsole.log(\"[Tagname] Your message\"); // [Tagname] Your message \r\nconsole.realtime(\"[Tagname] Your message\"); // [Tagname] Your message\r\nconsole.high(\"[Tagname] Your message \"); // [Tagname] Your message\r\nconsole.normal(\"[Tagname][]Your message\"); // [Tagname] []Your message\r\nconsole.low(\"[Tagname]Your message\"); // [Tagname] Your message\r\n\r\n// Tagging function\r\n// ----------------\r\nconsole.t(\"Tagname\").
