3.0.1

README.md

@@ -1,16 +1,36 @@
 # projectinfo
-returns a projectoinfo object for a directory path. TypeScript ready.
+gather information about projects. supports npm, git etc.
 
-## Status
+## Availabililty
-[![build status](https://gitlab.com/pushrocks/projectinfo/badges/master/build.svg)](https://gitlab.com/pushrocks/projectinfo/commits/master)
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/projectinfo)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/projectinfo)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/projectinfo)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/projectinfo/)
+
+## Status for master
+[![build status](https://GitLab.com/pushrocks/projectinfo/badges/master/build.svg)](https://GitLab.com/pushrocks/projectinfo/commits/master)
+[![coverage report](https://GitLab.com/pushrocks/projectinfo/badges/master/coverage.svg)](https://GitLab.com/pushrocks/projectinfo/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/projectinfo.svg)](https://www.npmjs.com/package/projectinfo)
 [![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)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/projectinfo/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/projectinfo/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/projectinfo/badges/code.svg)](https://www.bithound.io/github/pushrocks/projectinfo)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
+Use TypeScript for best in class instellisense.
 
-```TypeScript
+```javascript
-var projectinfo = require("projectinfo")
+import { ProjectInfo } from 'projectinfo'
 
-myProject = new ProjectinfoNpm("/somepath/to/projectroot");
+let myProjectInfo = new ProjectInfo('/some/path/to/proejct')
-myProject.version // displays version
+let npmName = myProjectInfo.npm.name // returns npm name from package.json
+let npmVersion = myProjectInfo.npm.version // returns version from package.json
+let gitRepo = myProjectInfo.git.gitrepo // returns the name of the gitrepo
+let gitRemotes = myProjectInfo.git.remotes // returns array with registered remotes
+
+// for more info check out the module in your IDE with TypeScript intellisense enabled
 ```
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "projectinfo",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "gather information about projects. supports npm, git etc.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",