diff --git a/README.md b/README.md index a38bfe1..fca5b80 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,65 @@ -# opentelemetry-erlang-contrib +--- +
+ + Getting Started + • + API Documentation + +
++ + Contributing + • + Instrumentation + • + Propagators + • + Examples + +
+ +--- +[![EEF Observability WG project](https://img.shields.io/badge/EEF-Observability-black)](https://github.com/erlef/eef-observability-wg) +![Elixir](https://github.com/open-telemetry/opentelemetry-erlang-contrib/actions/workflows/elixir.yml/badge.svg?branch=main) + +## About this project + +This is a repository for OpenTelemetry Erlang & Elixir contributions that are not part of the +[core repository](https://github.com/open-telemetry/opentelemetry-erlang) and +core distribution of the API and SDK. + +## Instrumentations + +OpenTelemetry can collect tracing data using instrumentation. Vendors/Users can also create and use their own. Currently, OpenTelemetry supports automatic tracing for: + +### Elixir Instrumentation + +- [opentelemetry-phoenix](https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/instrumentation/opentelemetry_phoenix) + +## Supported Runtimes + +OpenTelemetry requires OTP v21.3 and above. + +See [Elixir OTP Compatability](https://hexdocs.pm/elixir/1.12/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp) for supported OTP/Elixir combinations. + +## Contributing + +We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and +[good first issue][good-first-issues] to get started with the project. Follow +[CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal. + +## Useful links + +- For more information on OpenTelemetry, visit: