Skip to content

Commit e7f8c6f

Browse files
Merge pull request #64 from tidal/sf_bundle_readme
Update Readmes to reflect new composer packages
2 parents 3839f76 + 933e1f6 commit e7f8c6f

File tree

3 files changed

+38
-13
lines changed

3 files changed

+38
-13
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,19 @@ For more information, please, consult the documentation of the main [OpenTelemet
1010
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].
1111

1212
## Installation
13-
The recommended way to install the library is through [Composer](http://getcomposer.org):
13+
### Install individual packages:
14+
(This is the recommened way to install the components)
15+
16+
17+
Refer to the documentation for the individual components on how to install them
18+
19+
20+
- [AWS](/src/AWS/README.md)
21+
- [Symfony SdkBundle](/src/Symfony/OtelSdkBundle/README.md)
22+
23+
### Install the complete package:
24+
As an alternative to installing individual components you can install the whole package with all components
1425

15-
Install the package:
1626

1727
```bash
1828
$ composer require open-telemetry/opentelemetry-php-contrib

src/Aws/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
Readme for opentelemetry-php-contrib AWS package (temporary file)
1+
2+
## Installation
3+
4+
### 1.1. Install PHP library/SDK dependencies
5+
6+
Take a look at the documentation of the [PHP library](https://github.com/open-telemetry/opentelemetry-php) on how to install its dependencies.
7+
8+
### 1.2. Install the Package
9+
10+
1. Add
11+
```bash
12+
"minimum-stability": "dev",
13+
"prefer-stable": true,
14+
```
15+
16+
To your project's `composer.json` file, as this utility has not reached a stable release status yet.
17+
18+
2. Install the package with composer:
19+
20+
```bash
21+
$ composer require open-telemetry/contrib-aws
22+
```
23+

src/Symfony/OtelSdkBundle/README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,25 +51,18 @@ Take a look at the documentation of the [PHP library](https://github.com/open-t
5151

5252
### 2.2. Install the Bundle
5353

54-
For now the bundle is only installable as part of the OpenTelemetry [opentelemetry-php-contrib](https://github.com/open-telemetry/opentelemetry-php-contrib)
55-
package.
56-
57-
The recommended way to install the library is through [Composer](http://getcomposer.org):
58-
59-
1. Install the composer package using [Composer's installation instructions](https://getcomposer.org/doc/00-intromd#installation-linux-unix-macos).
60-
61-
2. Add
54+
1. Add
6255
```bash
6356
"minimum-stability": "dev",
6457
"prefer-stable": true,
6558
```
6659

6760
To your project's `composer.json` file, as this utility has not reached a stable release status yet.
6861

69-
3. Install the package with composer:
62+
2. Install the package with composer:
7063

7164
```bash
72-
$ composer require open-telemetry/opentelemetry-php-contrib
65+
$ composer require open-telemetry/contrib-sdk-bundle
7366
```
7467

7568

0 commit comments

Comments
 (0)