Fix docs to reflect focus on HAR

micmro · Mar 25, 2017 · 24d41f8 · 24d41f8
1 parent 88162c5
commit 24d41f8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git 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
@@ -4,7 +4,7 @@
 <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-    <title>PerfCascade - HAR and more Waterfall viewer</title>
+    <title>PerfCascade - HAR Waterfall viewer</title>
     <meta name="description" content="">
     <meta name="viewport" content="width=device-width, initial-scale=1">