Merge pull request #5 from RaisinTen/move-example-under-docs

Move example under docs

Author: RaisinTen

.npmignore

@@ -1,5 +1,4 @@
 .github
-events.json
 example-perfetto.png
-example.js
+examples
 test

docs/examples/tracing-async-operations/.gitignore

@@ -0,0 +1 @@
+events.json

docs/examples/tracing-async-operations/README.md

@@ -0,0 +1,25 @@
+# Tracing async operations
+
+A new `TraceEvents` object is created in:
+
+https://github.com/RaisinTen/perftrace/blob/e9df1f8c4488a69c9051e8a62f0896ca7af677a6/docs/examples/tracing-async-operations/index.js#L6
+
+Before the process exits, the `TraceEvents` object is destroyed and the trace events are stringified and printed to `events.json` in:
+
+https://github.com/RaisinTen/perftrace/blob/e9df1f8c4488a69c9051e8a62f0896ca7af677a6/docs/examples/tracing-async-operations/index.js#L8-L12
+
+The code that needs to be profiled can be done using the `peformance.measure()` and `peformance.mark()` APIs from [Node.js](https://nodejs.org/api/perf_hooks.html#performancemarkname-options) and the [Web](https://www.w3.org/TR/user-timing):
+
+```js
+peformance.mark("before");
+// code that needs to be profiled
+performance.measure("after", "before");
+```
+
+like it's being done in:
+
+https://github.com/RaisinTen/perftrace/blob/e9df1f8c4488a69c9051e8a62f0896ca7af677a6/docs/examples/tracing-async-operations/index.js#L14-L26
+
+After running `node .`, the generated `events.json` file can be opened on [https://ui.perfetto.dev](https://ui.perfetto.dev) for visualization:
+
+![](./perfetto.png)

example.js …amples/tracing-async-operations/index.jsexample.js renamed to docs/examples/tracing-async-operations/index.js example.js renamed to docs/examples/tracing-async-operations/index.js

@@ -1,4 +1,4 @@
-const { TraceEvents } = require(".");
+const { TraceEvents } = require("../../..");
 
 const { performance } = require("node:perf_hooks");
 const { writeFileSync } = require("node:fs");

docs/examples/tracing-async-operations/package-lock.json

@@ -0,0 +1,9 @@
+{
+  "name": "tracing-async-operations",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Tracing async operations",
+  "main": "index.js",
+  "author": "Darshan Sen",
+  "license": "MIT"
+}