Skip to content

Commit 2d70101

Browse files
committed
Add basic documentation
1 parent 40e0510 commit 2d70101

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,48 @@
1-
# opentelemetry-php-contrib
2-
opentelemetry-php-contrib
1+
# OpenTelemetry php contrib library
2+
3+
## Current Project Status
4+
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.
5+
6+
For more information, please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php).
7+
8+
## Installation
9+
The recommended way to install the library is through [Composer](http://getcomposer.org):
10+
11+
1.) Install the composer package using [Composer's installation instructions](https://getcomposer.org/doc/00-intromd#installation-linux-unix-macos).
12+
13+
2.) Add
14+
```bash
15+
"minimum-stability": "dev",
16+
"prefer-stable": true,
17+
"repositories": [
18+
{
19+
"type": "vcs",
20+
"url": "https://github.com/open-telemetry/opentelemetry-php-contrib"
21+
}
22+
],
23+
```
24+
25+
To your project's `composer.json` file, as this utility has not reached a stable release status yet,
26+
and is not yet registered on packagist.org
27+
28+
3.) Install the dependency with composer:
29+
30+
```bash
31+
$ composer require open-telemetry/opentelemetry-php-contrib
32+
```
33+
34+
## Usage/Examples
35+
36+
### AWS
37+
- You can find examples on how to use the ASW classes in the [examples directory](/examples/aws/README.md).
38+
39+
### Symfony
40+
#### SdkBundle
41+
- The documentation for the Symfony SdkBundle can be found [here](/src/instrumentation/symfony/OtelSdkBundle/README.md).
42+
- An example symfony application using the SdkBundle can be found [here](https://github.com/tidal/otel-sdk-bundle-example-sf5).
43+
44+
45+
## Development
46+
47+
Please, consult the documentation of the main [OpenTelemetry php project](https://github.com/open-telemetry/opentelemetry-php).
48+

0 commit comments

Comments
 (0)