Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated readme examples to es6 #206

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated readme examples to es6 #206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

plato was updated to support es6 by @devcrust, but needs an active maintainer to keep it moving forward.

[![Build Status](https://travis-ci.org/es-analysis/plato.png?branch=master)](https://travis-ci.org/es-analysis/plato)
[![Build Status](https://travis-ci.org/es-analysis/plato.svg?branch=master)](https://travis-ci.org/es-analysis/plato)

Visualize JavaScript source complexity with plato.

Expand Down Expand Up @@ -61,25 +61,24 @@ plato -r -d report -l .jshintrc -t "My Awesome App" -x .json routes/*.js

### From scripts

```
var plato = require('plato');
```js
const plato = require('plato');

var files = [
const files = [
'path/to/javascript/file1.js',
...
'path/to/javascript/fileN.js'
];

var outputDir = './output/dir';
const outputDir = './output/dir';
// null options for this example
var options = {
const options = {
title: 'Your title here'
};

var callback = function (report){
const callback = (report) => {
// once done the analysis,
// execute this
};
}

plato.inspect(files, outputDir, options, callback);
```
Expand Down Expand Up @@ -127,7 +126,3 @@ plato.inspect(files, outputDir, options, callback);
## License
Copyright (c) 2012 Jarrod Overson
Licensed under the MIT license.


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/es-analysis/plato/trend.png)](https://bitdeli.com/free "Bitdeli Badge")