Skip to content

Commit 98ecaee

Browse files
committed
Readme
1 parent 6ffcdb3 commit 98ecaee

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,28 @@
44
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/thettler/laravel-console-toolkit/run-tests?label=tests)](https://github.com/thettler/laravel-console-toolkit/actions?query=workflow%3Arun-tests+branch%3Amain)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/thettler/laravel-console-toolkit/Check%20&%20fix%20styling?label=code%20style)](https://github.com/thettler/laravel-console-toolkit/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/thettler/laravel-console-toolkit.svg?style=flat-square)](https://packagist.org/packages/thettler/laravel-console-toolkit)
7+
[![PHP Version](https://img.shields.io/packagist/php-v/thettler/laravel-console-toolkit?style=flat-square)](https://packagist.org/packages/thettler/laravel-console-toolkit)
8+
79

810
![Header Image](/.github/header_img.png)
911

10-
This package makes it even easier to write maintainable and expressive Artisan commands with argument/option casting,
12+
This package makes it even easier to write maintainable and expressive Artisan commands, with argument/option casting,
1113
validation and autoAsk. Also, it lets you define your arguments/options with simple properties and attributes for better
1214
ide support and static analysis. And all this with a single trait.
1315

1416
## 🤯 Features
1517

16-
All the features with on look:
18+
All the features:
1719

18-
| Support | Name | Description |
19-
|:--------:|:----------------------|--------------------------------------------------------------------------------------------------------------------------|
20-
| ☑️ | Laravel Features | Supports everything laravel can do |
21-
| ☑️ | Attribute Syntax | Use PHP-Attributes to automatically define your inputs based on types |
22-
| ☑️ | Casting | Automatically cast your inputs to Enums, Models, Objects or anything you want |
23-
| ☑️ | Validation | Use the Laravel Validator to validate the inputs from the console |
24-
| ☑️ | Auto Ask | If the user provides an invalid value toolkit will ask again for a valid value without the need to run the command again |
25-
| ☑️ | Negatable Options | Options can be specified as opposites: --dry or --no-dry |
26-
| ☑️ | Option required Value | Options can have required values |
20+
| Support | Name | Description |
21+
|:-------:|:----------------------|--------------------------------------------------------------------------------------------------------------------------|
22+
| | Laravel Features | Supports everything laravel can do |
23+
| | Attribute Syntax | Use PHP-Attributes to automatically define your inputs based on types |
24+
| | Casting | Automatically cast your inputs to Enums, Models, Objects or anything you want |
25+
| | Validation | Use the Laravel Validator to validate the inputs from the console |
26+
| | Auto Ask | If the user provides an invalid value toolkit will ask again for a valid value without the need to run the command again |
27+
| | Negatable Options | Options can be specified as opposites: --dry or --no-dry |
28+
| | Option required Value | Options can have required values |
2729

2830
## :purple_heart: Support me
2931

@@ -133,9 +135,9 @@ class BasicCommand extends Command
133135
{
134136
protected $signature = 'basic';
135137

136-
protected $description = 'Some usefull description.';
138+
protected $description = 'Some useful description.';
137139

138-
protected $help = 'Some helpfull text.';
140+
protected $help = 'Some helpful text.';
139141

140142
protected $hidden = true;
141143
...
@@ -751,7 +753,7 @@ The enum cast will automatically cast every typed enum to this enum. But you can
751753
protected Enum $enum;
752754
```
753755

754-
### Array Cast
756+
#### Array Cast
755757

756758
If you have an array and want to cast all its values to a specific type you can use the ArrayCaster. It expects a caster
757759
and a specific type:

0 commit comments

Comments
 (0)