Skip to content

Commit 74253cb

Browse files
committed
Add warning about feature flags
1 parent 20a18b0 commit 74253cb

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ composer require temporal/sdk
2121
[![License](https://img.shields.io/packagist/l/temporal/sdk.svg?style=flat-square)](LICENSE.md)
2222
[![Total DLoads](https://img.shields.io/packagist/dt/temporal/sdk.svg?style=flat-square)](https://packagist.org/packages/temporal/sdk/stats)
2323

24-
The SDK includes two main components: [Clients](https://docs.temporal.io/develop/php/temporal-clients) and Workers.
24+
The SDK includes two main components: [Clients](https://docs.temporal.io/develop/php/temporal-clients) and Workers.
2525
The Clients component is used to start, schedule, and manage Workflows;
2626
the Workers component is used to execute Workflows and Activities.
2727

28-
The client part of the SDK requires the [`grpc` extension](https://pecl.php.net/package/grpc),
28+
The client part of the SDK requires the [`grpc`](https://pecl.php.net/package/grpc) extension,
2929
and the worker requires [RoadRunner](https://roadrunner.dev).
30-
It is recommended to use both SDK components with the [`protobuf` extension](https://pecl.php.net/package/protobuf)
30+
It is recommended to use both SDK components with the [`protobuf`](https://pecl.php.net/package/protobuf) extension
3131
in production to improve performance.
3232

3333
| | Client | Worker |
@@ -54,7 +54,13 @@ If you are using the SDK without integrations, the following sections of the doc
5454
- [How to start a Workflow Execution](https://docs.temporal.io/develop/php/temporal-clients#start-workflow-execution)
5555

5656
> [!NOTE]
57-
> Check out [the repository with examples](https://github.com/temporalio/samples-php) of using the SDK.
57+
> Check out [the repository with examples](https://github.com/temporalio/samples-php) of using the PHP SDK.
58+
59+
> [!WARNING]
60+
> Since version [`2.11.0`](https://github.com/temporalio/sdk-php/releases/tag/v2.11.0),
61+
> [feature flags](https://github.com/temporalio/sdk-php/blob/master/src/Worker/FeatureFlags.php) were introduced
62+
> that change the behavior of the entire PHP worker.
63+
> It's recommended to disable deprecated behavior.
5864
5965
## Testing
6066

@@ -104,6 +110,6 @@ Additional
104110

105111
## License
106112

107-
Buggregator Trap is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT).
113+
Temporal PHP SDK is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT).
108114

109115
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftemporalio%2Fsdk-php.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftemporalio%2Fsdk-php?ref=badge_large)

0 commit comments

Comments
 (0)