Skip to content

Commit 24d41f8

Browse files
author
Michael Mrowetz
committed
Fix docs to reflect focus on HAR
1 parent 88162c5 commit 24d41f8

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

Diff for: README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# PerfCascade
2-
Extensible waterfall-viewer that works with [HAR](http://www.softwareishard.com/blog/har-12-spec/) and other formats (in the future).
2+
Responsive, SVG based [HAR](http://www.softwareishard.com/blog/har-12-spec/) waterfall viewer .
33

44
[![Build status][travis-image]][travis-url]
55

@@ -95,6 +95,10 @@ perfCascadeFileReader.readFile(fileFromTheFileInput, fileName, function(error, d
9595
Optionally `perfCascadeFileReader.readFile` also takes a callback (`(progress:number) => void`) as a forth argument
9696
that gets called whenever a new unzip progress status is available.
9797

98+
## Rendering other formats (than HAR)
99+
PerfCascade is composed of a parser (`src/ts/transformers/har.ts`) that parsed HAR into PerfCascade's agnostic `WaterfallDocs` format and the renderer (see `PerfCascade()` in `src/ts/main.ts`) that creats the chart SVG.
100+
101+
If you want to render another format, you could clone the repo and create a new parser. It would also be possible to seperate the renderer into a seperate package, if there is enough interest to justify the effort (create an issue and we can discuss it).
98102

99103
## Dev
100104
- Start live-reload server and Typescript compiler with watch: `npm run watch`

Diff for: src/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8">
66
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
7-
<title>PerfCascade - HAR and more Waterfall viewer</title>
7+
<title>PerfCascade - HAR Waterfall viewer</title>
88
<meta name="description" content="">
99
<meta name="viewport" content="width=device-width, initial-scale=1">
1010

0 commit comments

Comments
 (0)