Skip to content

Rename the quick start to Quick start guide and usage #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imanimanyara merged 1 commit into from
Oct 3, 2026
Merged

Rename the quick start to Quick start guide and usage #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
Expand Down
Loading