Skip to content
This repository has been archived by the owner on Nov 15, 2018. It is now read-only.

Commit

Permalink
Update README with basic api usage
Browse files Browse the repository at this point in the history
  • Loading branch information
lholmquist committed Sep 19, 2016
1 parent 9a576c7 commit 7ce94bd
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ The default output is to the console, but you can specify a "reporter" of file t

$szero /path_to/myproject --reporter=file

### Programmatic API

To use the `szero` api in code, first install it locally

$ npm install szero --save

Then require it in your code and call the report method, which returns a Promise:

const szero = require('szero');
szero.report(directory).then((jsonReport) => {
console.log(jsonReport);
});


## Contributing

Please read the [contributing guide](./CONTRIBUTING.md)

0 comments on commit 7ce94bd

Please sign in to comment.