Updated README.md

Author: marickvantuil

README.md

@@ -11,22 +11,16 @@
 
 This package allows you to use Google Cloud Tasks as your queue driver.
 
-**This is a WIP package, use at own risk**
+# How it works
 
-# How it works [!]
-
-!! Please read this next section !!
-
-You may already know this, but using Google Cloud Tasks is fundamentally different than typical Laravel queues.
+Using Cloud Tasks as a Laravel queue driver is fundamentally different than other Laravel queue drivers, like Redis.
 
 Typically a Laravel queue has a worker that listens to incoming jobs using the `queue:work` / `queue:listen` command.
 With Cloud Tasks, this is not the case. Instead, Cloud Tasks will schedule the job for you and make an HTTP request to your application with the job payload. There is no need to run a `queue:work/listen` command.
 
-Please read the following resource on how to correctly configure your queue so your application doesn't get overloaded with queue request:
-
-https://cloud.google.com/tasks/docs/configuring-queues
+For more information on how to configure the Cloud Tasks queue, read the next section [Configuring the queue](#configuring-the-queue)
 
-This package uses the HTTP request handler and doesnt' support AppEngine yet. But feel free to contribute! I myself don't use AppEngine.
+This package uses the HTTP request handler and doesn't support AppEngine. But feel free to contribute!
 
 # Requirements
 
@@ -50,15 +44,10 @@ Please check the table below for supported Laravel and PHP versions:
 composer require stackkit/laravel-google-cloud-tasks-queue
 ```
 
-(2) Create a new Cloud Tasks queue using `gcloud`
-
-````bash
-gcloud tasks queues create [QUEUE_ID]
-````
 
 [Official documentation - Creating Cloud Tasks queues](https://cloud.google.com/tasks/docs/creating-queues)
 
-(3) Add a new queue connection to `config/queue.php`
+(2) Add a new queue connection to `config/queue.php`
 
 ```
 'cloudtasks' => [
@@ -72,8 +61,83 @@ gcloud tasks queues create [QUEUE_ID]
 ],
 ```
 
-(4) Update the `QUEUE_CONNECTION` environment variable
+(3) Update the `QUEUE_CONNECTION` environment variable
 
 ```
 QUEUE_CONNECTION=cloudtasks
 ```
+
+(4) Create a new Cloud Tasks queue using `gcloud`
+
+````bash
+gcloud tasks queues create [QUEUE_ID]
+````
+
+Now that the package is installed, the final step is to set the correct environment variables.
+
+Please check the table below on what the values mean and what their value should be.
+
+|Environment variable|Description|Example
+|---|---|---
+|`STACKKIT_CLOUD_TASKS_PROJECT`|The project your queue belongs to.|`my-project`
+|`STACKKIT_CLOUD_TASKS_LOCATION`|The region where the AppEngine is hosted|`europe-west6`
+|`STACKKIT_CLOUD_TASKS_HANDLER`|The URL that Cloud Tasks will call to process a job. This should be the URL to your Laravel app with the `handle-task` path added|`https://<your website>.com/handle-task`
+|`STACKKIT_CLOUD_TASKS_QUEUE`|The queue a job will be added to|`emails`
+|`STACKKIT_CLOUD_TASKS_SERVICE_EMAIL`|The emailaddress of the AppEngine service account. Important, it should have the *Cloud Tasks Enqueuer* role|`[email protected]`
+# Configuring the queue
+
+When you first create a queue using `gcloud tasks queues create`, the default settings will look something like this:
+
+```
+rateLimits:
+  maxBurstSize: 100
+  maxConcurrentDispatches: 1000
+  maxDispatchesPerSecond: 500.0
+retryConfig:
+  maxAttempts: 100
+  maxBackoff: 3600s
+  maxDoublings: 16
+  minBackoff: 0.100s
+```
+
+## Configurable settings
+
+### maxBurstSize
+
+Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high.
+
+### maxConcurrentDispatches
+
+The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue
+
+### maxDispatchesPerSecond
+
+The maximum rate at which tasks are dispatched from this queue.
+
+### maxAttempts
+
+Number of attempts per task. Cloud Tasks will attempt the task max_attempts times (that is, if the first attempt fails, then there will be max_attempts - 1 retries). Must be >= -1.|
+
+### maxBackoff
+
+A task will be scheduled for retry between min_backoff and max_backoff duration after it fails
+
+### maxDoublings
+
+The time between retries will double max_doublings times.
+
+A task's retry interval starts at min_backoff, then doubles max_doublings times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times.
+              
+For example, if min_backoff is 10s, max_backoff is 300s, and max_doublings is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
+
+## Recommended settings for Laravel
+
+To simulate a single `queue:work/queue:listen` process, simply set the `maxConcurrentDispatches` to 1:
+
+```
+gcloud tasks queues update [QUEUE_ID] --max-concurrent-dispatches=1
+```
+
+More information on configuring queues:
+
+https://cloud.google.com/tasks/docs/configuring-queues