Skip to content

Commit

Permalink
#145 reordering readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanjudis committed Mar 19, 2015
1 parent 94f6cf6 commit 6675ebe
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ phantomas : {
}
```

#### options.buildUi
Type: `Boolean`
Default value: `true`

If you want to use `grunt-phantomas` without generating a UI for the data, this is an option to switch off the visualization interface. If set to false only defined data format will be outputted at `options.indexPath + '/data/'`.

#### options.indexPath
Type: `String`
Default value: `./phantomas/`
Expand All @@ -105,19 +111,6 @@ Default value: `{}`

An object that represents possible options for `phantomas` executable. For more information please check [the official api documentation](https://github.com/macbre/phantomas/wiki/npm-module) and [list of possible parameters](https://github.com/macbre/phantomas). See usage examples later on.

#### options.url
Type: `String`
Default value: `http:https://gruntjs.com/`

A string value that represents the url of the site, which will be analyzed by `phantomas`.


#### options.buildUi
Type: `Boolean`
Default value: `true`

If you want to use `grunt-phantomas` without generating a UI for the data, this is an option to switch off the visualization interface. If set to false only defined data format will be outputted at `options.indexPath + '/data/'`.

#### options.output
Type: `Array`
Default value: `[ 'json', 'csv' ]`
Expand Down Expand Up @@ -283,6 +276,11 @@ CHECKING FOR NOT DISPLAYED METRICS.
>> requests, gzipRequests, postRequests, httpsRequests, notFound, timeToFirstByte, timeToLastByte, bodySize, contentLength, ajaxRequests, htmlCount, htmlSize, cssCount, cssSize, jsCount, jsSize, jsonCount, jsonSize, imageCount, imageSize, webfontCount, webfontSize, base64Count, base64Size, otherCount, otherSize, cacheHits, cacheMisses, cachePasses, cachingNotSpecified, cachingTooShort, cachingDisabled, consoleMessages, domains, maxRequestsPerDomain, medianRequestsPerDomain, DOMqueries, DOMqueriesById, DOMqueriesByClassName, DOMqueriesByTagName, DOMqueriesByQuerySelectorAll, DOMinserts, DOMqueriesDuplicated, eventsBound, headersCount, headersSentCount, headersRecvCount, headersSize, headersSentSize, headersRecvSize, documentWriteCalls, evalCalls, jQueryOnDOMReadyFunctions, jQuerySizzleCalls, jsErrors, redirects, redirectsTime, assetsNotGzipped, assetsWithQueryString, smallImages, multipleRequests, timeToFirstCss, timeToFirstJs, timeToFirstImage, onDOMReadyTime, onDOMReadyTimeEnd, windowOnLoadTime, windowOnLoadTimeEnd, timeBackend, timeFrontend, httpTrafficCompleted, windowAlerts, windowConfirms, windowPrompts, cookiesRecv, domainsWithCookies, documentCookiesLength, documentCookiesCount, bodyHTMLSize, iframesCount, imagesWithoutDimensions, commentsSize, hiddenContentSize, whiteSpacesSize, DOMelementsCount, DOMelementMaxDepth, nodesWithInlineCSS, globalVariables, localStorageEntries, smallestResponse, biggestResponse, fastestResponse, slowestResponse, smallestLatency, biggestLatency, medianResponse, medianLatency
```

#### options.url
Type: `String`
Default value: `http:https://gruntjs.com/`

A string value that represents the url of the site, which will be analyzed by `phantomas`.

### Usage Examples

Expand Down

0 comments on commit 6675ebe

Please sign in to comment.