@paulirish/trace_engine 0.0.1 → 0.0.2

package/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+
+
+publish with 
+
+
+npm publish --access public --dry-run

package/README.md

@@ -2,6 +2,21 @@
 
 This folder contains the new trace engine that was first implemented for the Performance Insights panel and is now being repurposed as the primary trace engine that we use within DevTools.
 
+## API quickstart
+
+```js
+loadBrowserPolyfills();
+const TraceModel = await import('@paulirish/trace_engine');
+const processor = TraceModel.Processor.TraceProcessor.createWithAllHandlers();
+
+await processor.parse(traceEvents);
+console.log(processor.data)
+```
+
+**Note:** in reality to run in Node, you'll need to polyfill `window.location`, `window.navigator`, and `window.DOMRect`. 😜
+
+See the included `analyze-trace.mjs` a runnable invocation and quick polyfills.
+
 ## High level architecture
 
 ```

package/analyze-trace.mjs

@@ -10,7 +10,7 @@ import zlib from 'zlib';
 
 loadBrowserPolyfills(); // Must precede the import (for `location` and `navigator`)
 
-export const TraceModel = await import('././trace.mjs');
+export const TraceModel = await import('./trace.mjs');
 
 // If run as CLI, parse the argv trace (or a fallback)
 if (import.meta.url.endsWith(process.argv[1])) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paulirish/trace_engine",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "trace.mjs",
   "scripts": {
@@ -10,8 +10,7 @@
   "keywords": [],
   "author": "",
   "license": "BSD-3-Clause",
-  "dependencies": {
-  },
+  "dependencies": {},
   "devDependencies": {
     "zlib": "*"
   }