add README

2016-06-09 23:46:28 +02:00
parent 142cc52f95
commit 94a431ef33
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,16 @@
+# projectinfo
+returns a projectoinfo object for a directory path. TypeScript ready.
+
+## Status
+[![build status](https://gitlab.com/pushrocks/projectinfo/badges/master/build.svg)](https://gitlab.com/pushrocks/projectinfo/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/projectinfo.svg)](https://david-dm.org/pushrocks/projectinfo)
+[![devDependency Status](https://david-dm.org/pushrocks/projectinfo/dev-status.svg)](https://david-dm.org/pushrocks/projectinfo#info=devDependencies)
+
+## Usage
+
+```TypeScript
+var projectinfo = require("projectinfo")
+
+myProject = new ProjectinfoNpm("/somepath/to/projectroot");
+myProject.version // displays version
+```