From ef357c12ad22eaead59353d1628c48d79ae8c0ef Mon Sep 17 00:00:00 2001 From: fokosun Date: Sun, 12 Nov 2023 20:02:48 -0500 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1763f3c..176e8fe 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,14 @@ Run the following artisan command in the root of your Laravel project. ```text composer require fokosun/artisan-chain-commands ``` - +Lastly, add Artisan Chain Commands to the list of providers in `config/app` under providers: +```text +'providers' => ServiceProvider::defaultProviders()->merge([ + ... + \Fokosun\ArtisanChainCommands\Providers\ArtisanChainCommandsProvider::class, + ... +])->toArray(), +``` ## How to use You can chain multiple artisan commands with ease but there are a few commands that are not supported. See list below. @@ -39,6 +46,14 @@ You can chain multiple artisan commands with ease but there are a few commands t Artisan chain command will ignore these commands for the reasons outlined in the table above. +## Shorthand commands +Artisan chain commands also ship with a few shorthand commands which are essentially a chain of commonly used commands to aid development. An example are the `'config:clear', 'cache:clear', 'view:clear'` commands combination. These can be run with just one single shorthand command. See list below: +```text +'clear:ccv' => ['config:clear', 'cache:clear', 'view:clear'], +'clear:*' => ['config:clear', 'cache:clear', 'view:clear','event:clear', 'optimize:clear', 'queue:clear'], +'db:rms' => ['migrate:refresh', 'migrate', 'db:seed'], +``` + ## Contributing This is opensource and contributions are highly welcome.