push.rocks/smartlog-destination-local
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated Readme

Browse Source
This commit is contained in:
Philipp Kunz 2015-11-16 23:32:40 +01:00
parent 7a5d1469ba
commit 60d6cddea7
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -8,7 +8,12 @@ beautiful logging
## Usage ## Usage
```javascript ```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.log('some log message'); //normal console log message
bl.success('some success message'); //success console log message bl.success('some success message'); //success console log message
bl.error('some error message'); //error 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 success message','success');
bl.log('some error message','error'); 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.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
```