From ce56916db761c19fcc7d8e4b027485241a0e2c83 Mon Sep 17 00:00:00 2001
From: Philipp Kunz <kunzphp@gmail.com>
Date: Thu, 26 Nov 2015 06:51:13 +0100
Subject: [PATCH] updated readme

---
 README.md            |  2 +-
 ts/compile/readme.md | 28 +++++++++++++++++++++++++++-
 ts/test.js           |  1 +
 ts/test.js.map       |  2 +-
 ts/test.ts           |  1 +
 5 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 50a83b5..06e159c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,2 @@
-# pushrocks
+# smartenv
 wrapper for all non-gulp npm plugins
diff --git a/ts/compile/readme.md b/ts/compile/readme.md
index b43dc07..ffcb901 100644
--- a/ts/compile/readme.md
+++ b/ts/compile/readme.md
@@ -1,2 +1,28 @@
 # How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.
\ No newline at end of file
+store things about your environment and let them travel across modules
+
+## Status
+[![Build Status](https://travis-ci.org/pushrocks/smartenv.svg?branch=release)](https://travis-ci.org/pushrocks/smartenv)
+[![Dependency Status](https://david-dm.org/pushrocks/smartenv.svg)](https://david-dm.org/pushrocks/smartenv)
+[![devDependency Status](https://david-dm.org/pushrocks/smartenv/dev-status.svg)](https://david-dm.org/pushrocks/smartenv#info=devDependencies)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartenv/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartenv/master/dependencies/npm)
+[![bitHound Overalll Score](https://www.bithound.io/github/pushrocks/smartenv/badges/score.svg)](https://www.bithound.io/github/pushrocks/smartenv)
+
+## Install
+Install the package through npm
+
+```
+npm install smartenv
+```
+
+## Usage
+
+```javascript
+var smartenv = require("smartenv");
+
+smartenv.info(); //prints an output about your current environment and registered objects
+smartenv.register({akey:"a text"},"somevalue"); // register a new object
+smartenv.makeGlobal() // make smartenv available from gobal.smartenv
+smartenv.get("somevalue").akey; // returns "a text"
+smartenv.items.somevalue.akey; // also returns "a text"
+```
\ No newline at end of file
diff --git a/ts/test.js b/ts/test.js
index 91021e1..515c6ab 100644
--- a/ts/test.js
+++ b/ts/test.js
@@ -3,6 +3,7 @@ var smartenv = require("./index.js");
 var beautylog = require("beautylog")("os");
 beautylog.info("Now testing the smartenv module");
 smartenv.info();
+beautylog.info("Now testing the smartenv module");
 smartenv.register({ key1: "Peter" }, "docit");
 smartenv.info();
 beautylog.log(smartenv.get("docit").key1);
diff --git a/ts/test.js.map b/ts/test.js.map
index 11639e5..9290dc2 100644
--- a/ts/test.js.map
+++ b/ts/test.js.map
@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,OAAO,EAAC,EAAC,OAAO,CAAC,CAAC;AAC1C,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAQ,CAAC,UAAU,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}
\ No newline at end of file
+{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,OAAO,EAAC,EAAC,OAAO,CAAC,CAAC;AAC1C,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAQ,CAAC,UAAU,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}
\ No newline at end of file
diff --git a/ts/test.ts b/ts/test.ts
index f09c0ea..d4de232 100644
--- a/ts/test.ts
+++ b/ts/test.ts
@@ -3,6 +3,7 @@ var smartenv = require("./index.js");
 var beautylog = require("beautylog")("os");
 beautylog.info("Now testing the smartenv module");
 smartenv.info();
+beautylog.info("Now testing the smartenv module");
 smartenv.register({key1:"Peter"},"docit");
 smartenv.info();
 beautylog.log(smartenv.get("docit").key1);