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

---
 README.md            | 28 +++++++++++++++++++++++++++-
 ts/compile/readme.md | 28 +---------------------------
 2 files changed, 28 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 06e159c..d58fd45 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # smartenv
-wrapper for all non-gulp npm plugins
+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/compile/readme.md b/ts/compile/readme.md
index ffcb901..b43dc07 100644
--- a/ts/compile/readme.md
+++ b/ts/compile/readme.md
@@ -1,28 +1,2 @@
 # How to compile.
-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
+Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.
\ No newline at end of file