Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fokosun committed Nov 13, 2023
1 parent 69475f2 commit ef357c1
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down

0 comments on commit ef357c1

Please sign in to comment.