README

nicjansma · Jul 12, 2016 · 3080150 · 3080150
1 parent 33f6533
commit 3080150
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# perf-timeline.js
+
+[http://nicj.net](http://nicj.net)
+
+Licensed under the MIT license
+
+## Introduction
+
+`perf-timeline.js` is a [GreaseMonkey](http://www.greasespot.net/) and [TamperMonkey](https://tampermonkey.net/) extension
+that shows a live timeline of performance data without having to open the developer tools.
+
+It is an demo project showing the data you can get for Real User Monitoring (RUM) based on the
+talk [Measuring Continuity](https://www.slideshare.net/nicjansma/measuring-continuity).  Some of the performance data captured:
+
+* Page Busy %
+* FPS
+* Video FPS
+* # of JavaScript Errors
+* Scroll Pixels
+* Scroll %
+* Click count
+* Mouse Move Pixels
+* Mouse Move %
+* Keypress count
+* Resources fetched count
+* DOM Change Count
+* DOM Change %
+* DOM Node Count
+* DOM Size Count
+
+## Usage
+
+Copy the contents of `perf-timeline.js` into GreaseMonkey or TamperMonkey.