Update README.md

Author: soap

README.md

@@ -5,15 +5,11 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/soap/laravel-workflow-process/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/soap/laravel-workflow-process/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/soap/laravel-workflow-process.svg?style=flat-square)](https://packagist.org/packages/soap/laravel-workflow-process)
 
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+Using [Zerodahero's Laravel Workflow (based on Symfony Workflow)](https://github.com/zerodahero/laravel-workflow) to handle state-transition workflow is great. However, coding transition guard in event is hard. This package provides a simple way, you can add Symfony Expression Language as a transition guard for each transition. This configuration must provided in transiton metadata using 'guard' as a key.
+This package subscribes for all workflows' transition guard events and uses provided Symfony Expression Language to allow to block the transition.
 
 ## Support us
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-workflow-process.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-workflow-process)
-
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
 
 ## Installation
 
@@ -23,13 +19,6 @@ You can install the package via composer:
 composer require soap/laravel-workflow-process
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="laravel-workflow-process-migrations"
-php artisan migrate
-```
-
 You can publish the config file with:
 
 ```bash
@@ -43,18 +32,62 @@ return [
 ];
 ```
 
-Optionally, you can publish the views using
-
-```bash
-php artisan vendor:publish --tag="laravel-workflow-process-views"
-```
-
 ## Usage
+Task that you have to do is providing guard configuration like the following example. This is in laravel-workflow 's configuration file (config/workflow.php). If you want to store workflow configuration in database, please visis [my Laravel Workflow Loader package](https://github.com/soap/laravel-workflow-loader).
 
 ```php
-$laravelWorkflowProcess = new Prasit Gebsaap\LaravelWorkflowProcess();
-echo $laravelWorkflowProcess->echoPhrase('Hello, Prasit Gebsaap!');
+// file config/workflow.php
+use ZeroDaHero\LaravelWorkflow\MarkingStores\EloquentMarkingStore;
+
+return [
+    'blogPost' => [
+        'type' => 'workflow',
+        'supports' => [App\Models\BlogPost::class],
+        'marking_store' => [
+            'property' => 'state',
+            'type' => 'single_state',
+            'class' => EloquentMarkingStore::class,
+        ],
+        'places' => ['draft', 'pending_for_review', 'approved', 'rejected', 'published', 'archived'],
+        'transitions' => [
+            'submit' => [
+                'from' => 'draft',
+                'to' => 'pending_for_review',
+                'metadata' => [
+                    'guard' => 'authenticated and subject.isOwnedBy(user)',
+                ],
+            ],
+            'approve' => [
+                'from' => 'pending_for_review',
+                'to' => 'approved',
+            ],
+            'reject' => [
+                'from' => 'pending_for_review',
+                'to' => 'rejected',
+            ],
+            'publish' => [
+                'from' => 'approved',
+                'to' => 'published',
+            ],
+            'archive' => [
+                'from' => ['draft', 'rejected'],
+                'to' => 'archived',
+            ],
+        ],
+    ]
+    
+];
 ```
+Currenty these variables/objects were injected into Symfony Expression Language.
+
+- "subject" is the Eloquent model which is subject of a workflow
+- "user" is authenticated user.
+- "authenticated" boolean, true if user was authenticated.
+
+So you can call any method on the injected object.
+
+## Todo
+I have a plan to prover document role for user. For example, some users may be assign as "reviewer" or "approver" for Eloquent model. So we can use something like subject.hasActorRole('reviewer') or subject.canBeReviewedBy(user). Any suggestion is welcome.
 
 ## Testing