From 22ebfbee8f6f662d04d18ce01eb7738789242ce8 Mon Sep 17 00:00:00 2001 From: Brett McBride Date: Tue, 13 Dec 2022 02:04:50 +1100 Subject: [PATCH] update readme for beta (#90) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b220d4b4..c8acbc0e 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,6 @@ ## Current Project Status -This project currently lives in a pre-alpha status. Our current release is not production ready; it has been created in order to receive feedback from the community. - For more information, please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php). ## Issues @@ -15,17 +13,19 @@ Issues have been disabled for this repo in order to help main consistency betwee ## Installation ### Install individual packages: -(This is the recommened way to install the components) - +(This is the recommended way to install the components) Refer to the documentation for the individual components on how to install them - - [AWS](/src/AWS/README.md) - [Symfony SdkBundle](/src/Symfony/OtelSdkBundle/README.md) ## Usage/Examples +### Auto-instrumentation +Auto-instrumentation requires the [otel_instrumentation](https://github.com/open-telemetry/opentelemetry-php-instrumentation) PHP extension, and +the installation of one or more packages from [src/Instrumentation](./src/Instrumentation) + ### AWS - You can find examples on how to use the ASW classes in the [examples directory](/examples/aws/README.md).