diff --git a/README.md b/README.md new file mode 100644 index 0000000..df141b3 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +telemetry +========= +[![Latest release][latest-release-img]][latest-release-url] +[![Build status][build-status-img]][build-status-url] +[![Go Report Card][report-img]][report-url] +[![Documentation][doc-img]][doc-url] + +[latest-release-img]: https://img.shields.io/github/release/go-pogo/telemetry.svg?label=latest + +[latest-release-url]: https://github.com/go-pogo/telemetry/releases + +[build-status-img]: https://github.com/go-pogo/telemetry/actions/workflows/test.yml/badge.svg + +[build-status-url]: https://github.com/go-pogo/telemetry/actions/workflows/test.yml + +[report-img]: https://goreportcard.com/badge/github.com/go-pogo/telemetry + +[report-url]: https://goreportcard.com/report/github.com/go-pogo/telemetry + +[doc-img]: https://godoc.org/github.com/go-pogo/telemetry?status.svg + +[doc-url]: https://pkg.go.dev/github.com/go-pogo/telemetry + + +Package `telemetry` provides a simple and flexible way to setup OTEL to collect and expose metrics and telemetry data. + +```sh +go get github.com/go-pogo/telemetry +``` + +```sh +import "github.com/go-pogo/telemetry" +``` + +## Documentation + +Additional detailed documentation is available at [pkg.go.dev][doc-url] + +## Created with + + + +## License + +Copyright © 2023-2024 [Roel Schut](https://roelschut.nl). All rights reserved. + +This project is governed by a BSD-style license that can be found in the [LICENSE](LICENSE) file.