diff --git a/README.md b/README.md index 0594c95..cdb3fd0 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,15 @@ php artisan vendor:publish --tag=laranail::console-config php artisan vendor:publish --tag=laranail::console-lang ``` -## Quick start +## Quick start guide and usage + +### Getting started + +Nothing to configure: `ConsoleServiceProvider` registers itself through package discovery, +together with the `Console` and `Prompter` facades and the `prompter()` helper. The config and +language publishes above are only for customising them. + +### Usage ```php use Simtabi\Laranail\Console\Facades\Console; @@ -44,6 +52,14 @@ final class ReleaseSummaryCommand extends Command } ``` +Progress and a prompt: + +```php +Console::spinner('Compiling…')->run(fn () => compile()); + +$name = Console::prompter()->text('Your name', required: true)->getResult(); +``` + The full walkthrough is in [Getting started](docs/getting-started.md); everything else is in the [documentation index](#documentation). ## Documentation