From de4c4ac60d2683d4820175645bc5f99164a2ace6 Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 23 Apr 2019 10:56:08 +0200 Subject: [PATCH] add table of contents --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 397954de..697d7c5a 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,22 @@ Responsive, SVG based [HAR](http://www.softwareishard.com/blog/har-12-spec/) wat [![Build status][travis-image]][travis-url] Install via `npm install perf-cascade`
-See live example: https://micmro.github.io/PerfCascade/ +Live example: https://micmro.github.io/PerfCascade/ example screenshot +## Contents + +- [How to use PerfCascade](#how-to-use-perfcascade) + * [With ES6 Compatible Module Loader (Webpack, Babel, Typescript...)](#with-es6-compatible-module-loader--webpack--babel--typescript-) + * [As Global Object](#as-global-object) + * [Use via npm](#use-via-npm) +- [Options](#options) +- [`*.zhar` - zipped HAR files](#--zhar----zipped-har-files) +- [Rendering other formats (than HAR)](#rendering-other-formats--than-har-) +- [Dev](#dev) +- [Specs and resources](#specs-and-resources) + ## How to use PerfCascade PerfCascade is exported with [UMD](https://github.com/umdjs/umd), so you can use it as global object, via AMD (e.g. requireJS) or commonJS (internally it uses ES6 modules).