README.md

EdgeATX npm Demo

This is a simple logging module. It can be used to generate pretty/colorized logs or plain text logs suitable for a syslog environment. This was created as a simple npm demo for the Bleeding Edge Web Meetup (slide deck).

Usage

Creating a custom logger is straightforward. There are two configuration options that can be passed to a logger: prefix and colorize. By default, there is no prefix and colorize defaults to true.

var CustomLogger = require('../'),
    log = new CustomLogger({
      prefix: 'Test Server'
    }),
    log2 = new CustomLogger({
      colorize: false
    });

log.log('Basic text.');
log.info('Important information.');
log.warn('Watch out!');
log.error('Uh oh! Something is awry.');

console.log('\n===========================\n');

log2.log('Basic text.');
log2.info('Important information.');
log2.warn('Watch out!');
log2.error('Uh oh! Something is awry.');

The code above produces:

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install edgeatx-npm-demo --save

Tests

NOTICE: You must git clone https://github.com/edgeatx/npm-demo.git this module to obtain tests.

npm install
npm test

Dependencies

• chalk: Terminal string styling done right. Much color.

Dev Dependencies

• mocha: simple, flexible, fun test framework

License

MIT

Generated by package-json-to-readme