Skip to content

Commit 2dd5468

Browse files
authored
Update installation instructions for Durable Workflow
1 parent 075fd92 commit 2dd5468

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ sidebar_position: 2
66

77
## Requirements
88

9-
Workflow requires the following to run:
9+
Durable Workflow requires the following to run:
1010

1111
- PHP 8.1 or later
1212
- Laravel 9 or later
1313

14-
Workflow can be used with any queue driver that Laravel supports (except the `sync` driver), including:
14+
Durable Workflow can be used with any queue driver that Laravel supports (except the `sync` driver), including:
1515

1616
- Amazon SQS
1717
- Beanstalkd
@@ -20,19 +20,19 @@ Workflow can be used with any queue driver that Laravel supports (except the `sy
2020

2121
Each queue driver has its own [prerequisites](https://laravel.com/docs/12.x/queues#driver-prerequisites).
2222

23-
Workflow also requires a cache driver that supports [locks](https://laravel.com/docs/12.x/cache#atomic-locks).
23+
Durable Workflow also requires a cache driver that supports [locks](https://laravel.com/docs/12.x/cache#atomic-locks).
2424

25-
> ✨ SQS Support: `timer()` and `awaitWithTimeout()` work with any duration, even when using the SQS queue driver. Workflow automatically handles SQS's delay limitation transparently.
25+
> ✨ SQS Support: `timer()` and `awaitWithTimeout()` work with any duration, even when using the SQS queue driver. Durable Workflow automatically handles SQS's delay limitation transparently.
2626
27-
## Installing the Workflow package
27+
## Installing Durable Workflow
2828

29-
The Workflow package is installable via Composer. To install it, run the following command in your Laravel project:
29+
Durable Workflow is installable via Composer. To install it, run the following command in your Laravel project:
3030

3131
```bash
3232
composer require laravel-workflow/laravel-workflow
3333
```
3434

35-
After installing the Workflow package, you must also publish the migrations. To publish the migrations, run the following command:
35+
After installing, you must also publish the migrations. To publish the migrations, run the following command:
3636

3737
```bash
3838
php artisan vendor:publish --provider="Workflow\Providers\WorkflowServiceProvider" --tag="migrations"
@@ -46,4 +46,4 @@ php artisan migrate
4646

4747
## Running Workers
4848

49-
The Workflow package uses queues to run workflows and activities in the background. You will need to either run the `queue:work` [command](https://laravel.com/docs/12.x/queues#the-queue-work-command) or use [Horizon](https://laravel.com/docs/12.x/horizon) to run your queue workers. Without a queue worker, workflows and activities will not be processed. You cannot use the sync driver with queue workers.
49+
Durable Workflow uses queues to run workflows and activities in the background. You will need to either run the `queue:work` [command](https://laravel.com/docs/12.x/queues#the-queue-work-command) or use [Horizon](https://laravel.com/docs/12.x/horizon) to run your queue workers. Without a queue worker, workflows and activities will not be processed. You cannot use the sync driver with queue workers.

0 commit comments

Comments
 (0)