From 24d41f88506565668f0d880d9dc0ed2a8cfee467 Mon Sep 17 00:00:00 2001 From: Michael Mrowetz Date: Sat, 25 Mar 2017 17:16:10 +0900 Subject: [PATCH] Fix docs to reflect focus on HAR --- README.md | 6 +++++- src/index.html | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 297f1c95..962b655d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # PerfCascade -Extensible waterfall-viewer that works with [HAR](http://www.softwareishard.com/blog/har-12-spec/) and other formats (in the future). +Responsive, SVG based [HAR](http://www.softwareishard.com/blog/har-12-spec/) waterfall viewer . [![Build status][travis-image]][travis-url] @@ -95,6 +95,10 @@ perfCascadeFileReader.readFile(fileFromTheFileInput, fileName, function(error, d Optionally `perfCascadeFileReader.readFile` also takes a callback (`(progress:number) => void`) as a forth argument that gets called whenever a new unzip progress status is available. +## Rendering other formats (than HAR) +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. + +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). ## Dev - Start live-reload server and Typescript compiler with watch: `npm run watch` diff --git a/src/index.html b/src/index.html index e1438c54..1747b06f 100644 --- a/src/index.html +++ b/src/index.html @@ -4,7 +4,7 @@ - PerfCascade - HAR and more Waterfall viewer + PerfCascade - HAR Waterfall viewer