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

Update README.md

Browse Source
This commit is contained in:
Philipp Kunz 2016-05-19 06:53:51 +02:00
parent d8d9fef7e8
commit ebe1499daa
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -11,7 +11,7 @@ beautiful logging, TypeScript ready
## Usage
```javascript
```typescript
var beautylog = require("beautylog"); //for use in OS console environment AND browser console
beautylog.log("some log message"); // normal console log message
@ -30,9 +30,16 @@ beautylog.log("some error message","error");
The plugin produces beautiful output like this:
![console.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/console.png)
### Code Highlighting
### Ora Integration
beautylog wraps the excellent ora module from npm to better work with beautylog. In general that means that you can log persistent messages WHILE you are actually having an active Ora object. beautylog handles all the fuss for you.
```typescript
var myOra = new beautylog.Ora("my awesome text", "blue");
myOra.start();
beautylog.info("some persistent text") //does not disturb myOra
myOra.text("some updated text");
myOra.stop();
```
### Console Tables
beautylog allows displaying data in nice tables for better overview.
@ -66,3 +73,7 @@ myTable.print(); //prints myTable to the console
The table from the code with type "checks" above looks like this:
![table.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/table.png)
## About the authors:
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)