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:
LosslessBot 2016-05-03 23:09:57 +02:00
parent 043639ebff
commit 6875881cf3
2 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,28 +1,30 @@
# beautylog
beautiful logging
beautiful logging, TypeScript ready
## Status
[![Build Status](https://travis-ci.org/pushrocks/beautylog.svg?branch=v0.0.9)](https://travis-ci.org/pushrocks/beautylog)
[![Dependency Status](https://david-dm.org/pushrocks/beautylog.svg)](https://david-dm.org/pushrocks/beautylog)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/beautylog/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
[![bitHound Score](https://www.bithound.io/github/pushrocks/beautylog/badges/score.svg)](https://www.bithound.io/github/pushrocks/beautylog)
[![Coverage Status](https://coveralls.io/repos/github/pushrocks/beautylog/badge.svg?branch=greenkeeper-npmts-2.1.10)](https://coveralls.io/github/pushrocks/beautylog?branch=greenkeeper-npmts-2.1.10)
[![codecov](https://codecov.io/gh/pushrocks/beautylog/branch/master/graph/badge.svg)](https://codecov.io/gh/pushrocks/beautylog)
## Usage
```javascript
var beautylog = require("beautylog"); //for use in OS console environment AND browser console
### Simple Logging
var bl = require('beautylog'); //for use in OS console environment AND browser console
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
beautylog.log("some log message"); // normal console log message
beautylog.info("some log message") // info console log message
beautylog.ok("some log message"); // ok console log message
beautylog.warn("some log message"); // warn console log message
beautylog.success("some success message"); // success console log message
beautylog.error("some error message"); // error console log message
// alternatively you can use a logType parameter
bl.log('some log message','normal');
bl.log('some success message','success');
bl.log('some error message','error');
beautylog.log("some log message","normal");
beautylog.log("some success message","success");
beautylog.log("some error message","error");
/* ... and so on ... */
```
The plugin produces beautiful output like this:
![console.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/console.png)
@ -34,13 +36,15 @@ The plugin produces beautiful output like this:
### Console Tables
beautylog allows displaying data in nice tables for better overview.
> **Note:** This only works only in nodejs for now.
There are different types of tables.
#### Custom
```javascript
var bl = require('beautylog')("os"); //for use in OS console environment
var myTable = bl.table.new("custom",["Heading1".blue,"Heading2".blue,"Heading3".blue]); // type "custom"
var beautylog = require("beautylog");
var myTable = beautylog.table.new("custom",["Heading1".blue,"Heading2".blue,"Heading3".blue]); // type "custom"
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
@ -50,8 +54,8 @@ myTable.print(); //prints myTable to the console
#### Checks
```javascript
var bl = require('beautylog')("os"); //for use in OS console environment
var myTable = bl.table.new("checks"); // type checks
var beautylog = require("beautylog");
var myTable = beautylog.table.new("checks"); // type 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

2
package.json
View File

@ -1,7 +1,7 @@
{
"name": "beautylog",
"version": "4.1.5",
"description": "beautiful logging",
"description": "beautiful logging, TypeScript ready",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"scripts": {