Update README.md

2015-09-27 17:23:32 +02:00 · 2015-09-27 17:23:32 +02:00 · a69e5fc653
commit a69e5fc653
parent e03afcb843
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -4,3 +4,17 @@ beautiful logging
 ## Buildstatus
 [![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)
+
+
+## Usage
+```javascript
+var bl = require('beautylog');
+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
+
+//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');
+```