From 7e588db44a596b83237819aa754bbec225eeec65 Mon Sep 17 00:00:00 2001 From: Philipp Kunz Date: Tue, 17 Nov 2015 02:29:18 +0100 Subject: [PATCH] updated Readme and Test --- README.md | 39 +++++++++------------------------------ test.js | 7 +++++-- ts/test.ts | 8 ++++++-- 3 files changed, 20 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index dc1f425..e3784af 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,18 @@ -# gulp-bootstrap +# smartdebug works with gulp, but does nothing. Use it to bootstrap your own gulp plugin with TypeScript, Travis and npm. ### Buildstatus/Dependencies -[![Build Status](https://travis-ci.org/pushrocks/gulp-bootstrap.svg?branch=master)](https://travis-ci.org/pushrocks/gulp-bootstrap) -[![devDependency Status](https://david-dm.org/pushrocks/gulp-bootstrap/dev-status.svg)](https://david-dm.org/pushrocks/gulp-bootstrap#info=devDependencies) +[![Build Status](https://travis-ci.org/pushrocks/smartdebug.svg?branch=master)](https://travis-ci.org/pushrocks/smartdebug) +[![devDependency Status](https://david-dm.org/pushrocks/smartdebug/dev-status.svg)](https://david-dm.org/pushrocks/smartdebug#info=devDependencies) ### Usage -This npm package comes with everything you need to start your own gulp plugin. +This plugin is thought for easy debug logging. -Features: +```javascript +var smartDebug = require("smartdebug"); -* TypeScript: Code your plugin in TypeScript -* Use gulp to compile TypeScript without the global gulp CLI Tool. -* Use travis to deploy to npm -* Have a master branch for the latest dev version -* Have a release branch for the latest npm version - -This package **doesn't require global gulp** (just local -> simply do npm install`) to compile TypeScript. - -* to compile TypeScript do `npm test` (You should chain your own tests to this command later on) -* to setup release do `npm run setup` -* to release a patch do `npm run release` - -We recommend using travis for npm releasing and test integration. - -#### The structure - -``` -gulp-bootstrap/ -| -|- ts/ -| |- compile/ -| | |- compile.js **** contains gulp task` -| |- index.ts **** Your main TypeScript file. -| -|- index.js **** the compiled module +smartDebug.log("This message is not shown"); +smartDebug.activate(true); +smartDebug.log("This debug message is shown"); ``` diff --git a/test.js b/test.js index 3f6fd6e..7bdea54 100644 --- a/test.js +++ b/test.js @@ -1,4 +1,7 @@ +/// var smartDebug = require("./index.js"); -smartDebug.log("test"); +var bl = require("beautylog")("os"); +smartDebug.log("This message is not shown"); smartDebug.activate(true); -smartDebug.log("test2"); +smartDebug.log("This debug message is shown"); +bl.success("Test successfull"); diff --git a/ts/test.ts b/ts/test.ts index e8f7075..35a078f 100644 --- a/ts/test.ts +++ b/ts/test.ts @@ -1,5 +1,9 @@ +/// var smartDebug = require("./index.js"); +var bl = require("beautylog")("os"); -smartDebug.log("test"); +smartDebug.log("This message is not shown"); smartDebug.activate(true); -smartDebug.log("test2"); \ No newline at end of file +smartDebug.log("This debug message is shown"); + +bl.success("Test successfull"); \ No newline at end of file