0.0.3

README.md

@@ -1,2 +1,28 @@
-# pushrocks
-wrapper for all non-gulp npm plugins
+# smartenv
+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"
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartenv",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "store things about your environment and let them travel across modules",
   "main": "index.js",
   "scripts": {

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);

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"}
+{"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"}

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);