Skip to content

Commit

Permalink
Add doc links to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RaisinTen authored May 3, 2024
1 parent 4e982c0 commit 7e074a5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@
Record [`PerformanceEntry`](https://w3c.github.io/performance-timeline/#dom-performanceentry) objects from [Node.js](https://nodejs.org/api/perf_hooks.html) and the [Web](https://w3c.github.io/performance-timeline) in the [Trace Event Format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview), so that it can be visualized on <https://ui.perfetto.dev> like this!

![](./docs/examples/tracing-requires/perfetto.png)

The code for this example is available [here](docs/examples/tracing-requires).

## Install

```
npm i perftrace
```

## Usage

Check out the [API documentation](docs/api) and the [code examples](docs/examples).

## License

This project is available under the [MIT license](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for the full license text.

0 comments on commit 7e074a5

Please sign in to comment.