From ebe1499daa7c88ed3580821c7b7311835752268b Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Thu, 19 May 2016 06:53:51 +0200 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f26a4b..7418372 100644 --- a/README.md +++ b/README.md @@ -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)