add README
This commit is contained in:
parent
142cc52f95
commit
94a431ef33
16
README.md
Normal file
16
README.md
Normal file
@ -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
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user