Skip to content

Commit

Permalink
Add documentation links.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioquatix committed Apr 9, 2024
1 parent 7bc6d58 commit 52c00b8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ Capture metrics about code execution in a vendor agnostic way. As the author of

## Usage

Please see the [project documentation](https://socketry.github.io/metrics).
Please see the [project documentation](https://socketry.github.io/metrics/) for more details.

- [Getting Started](https://socketry.github.io/metrics/guides/getting-started/index) - This guide explains how to use `metrics` for capturing run-time metrics.

- [Capture](https://socketry.github.io/metrics/guides/capture/index) - This guide explains how to use `metrics` for exporting metric definitions from your application.

- [Testing](https://socketry.github.io/metrics/guides/testing/index) - This guide explains how to write assertions in your test suite to validate `metrics` are being emitted correctly.

## Contributing

Expand Down

0 comments on commit 52c00b8

Please sign in to comment.