diff --git a/README.md b/README.md index 9b862b8..69bc0a3 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,12 @@ beautiful logging ## Usage ```javascript -var bl = require('beautylog'); + +### Simple Logging +var bl = require('beautylog')("os"); //for use in OS console environment +var bl = require('beautylog')("browser"); //for use in browser console environment like Google Chrome + + bl.log('some log message'); //normal console log message bl.success('some success message'); //success console log message bl.error('some error message'); //error console log message @@ -18,5 +23,17 @@ bl.log('some log message','normal'); bl.log('some success message','success'); bl.log('some error message','error'); ``` -The plugin produces beautyful output like this: +The plugin produces beautiful output like this: ![console.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/console.png) + +### Console Tables +beautylog allows displaying data in nice tables for better overview. + +```javascript +var bl = require('beautylog')("os"); //for use in OS console environment +var myTable = bl.table.new("checks") +myTable.push(["check 1","success"]); // adds a row the myTable +myTable.push(["check 2","error"]); // adds a row the myTable +myTable.push(["check 3","error"]); // adds a row the myTable +myTable.print(); //prints myTable to the console +```