From 8a0454fae8868155a1d21710ec2774aa5b1e8cae Mon Sep 17 00:00:00 2001 From: Tom Carrio Date: Wed, 26 Jul 2023 09:14:31 -0400 Subject: [PATCH] docs: update README with minor fixes and formatting --- README.md | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 15e7b1ba..8b143ab5 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,17 @@ ![CI Build](https://github.com/open-telemetry/opentelemetry-php-contrib/workflows/PHP%20QA/badge.svg) [![codecov](https://codecov.io/gh/open-telemetry/opentelemetry-php-contrib/branch/main/graph/badge.svg)](https://codecov.io/gh/open-telemetry/opentelemetry-php) - ## Current Project Status -For more information, please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php). +For more information, please, consult the documentation of the main [OpenTelemetry PHP project][opentelemetry-php]. ## Issues -Issues have been disabled for this repo in order to help main consistency between this repo and the main opentelemetry-php repo. If you have an issue you'd like to raise about this issue, please use the [OpenTelemetry PHP Issue section](https://github.com/open-telemetry/opentelemetry-php/issues/new/choose). Please prefix the title of the issue with [opentelemetry-php-contrib]. +Issues have been disabled for this repo in order to help maintain consistency between this repo and the main [opentelemetry-php] repo. If you have an issue you'd like to raise about this issue, please use the [OpenTelemetry PHP Issue section](https://github.com/open-telemetry/opentelemetry-php/issues/new/choose). Please prefix the title of the issue with [opentelemetry-php-contrib]. ## Installation -### Install individual packages: + +### Install individual packages: + (This is the recommended way to install the components) Refer to the documentation for the individual components on how to install them @@ -20,29 +21,38 @@ Refer to the documentation for the individual components on how to install them - [AWS](/src/Aws/README.md) - [Symfony SdkBundle](/src/Symfony/README.md) -## Usage/Examples +## Usage/Examples ### Auto-instrumentation -Auto-instrumentation requires the [ext-opentelemetry](https://pecl.php.net/package/opentelemetry) PHP extension, and + +Auto-instrumentation requires the [ext-opentelemetry][] 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). + +- You can find examples on how to use the AWS classes in the [examples directory](/examples/aws/README.md). ### Symfony + #### SdkBundle -- The documentation for the Symfony SdkBundle can be found [here](/src/Symfony/README.md). -- An example symfony application using the SdkBundle can be found [here](https://github.com/opentelemetry-php/otel-sdk-bundle-example-sf5). +- The documentation for the Symfony SdkBundle can be found [here](/src/Symfony/README.md). +- An example Symfony application using the SdkBundle can be found [here](https://github.com/opentelemetry-php/otel-sdk-bundle-example-sf5). ## Development -Please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php). +Please, consult the documentation of the main [OpenTelemetry PHP project][opentelemetry-php]. ### Subprojects -This repository is organised into multiple separate sub-projects, under `/src`. + +This repository is organized into multiple separate sub-projects, under `/src`. Please remember to run all tests as you develop, the makefile supports a `PROJECTS` variable, which corresponds to the path of the project (relative to `src/`), eg ``` $ PROJECT=Symfony PHP_VERSION=8.1 make all -``` \ No newline at end of file +``` + + + +[opentelemetry-php]: https://github.com/open-telemetry/opentelemetry-php +[ext-opentelemetry]: https://pecl.php.net/package/opentelemetry