This repository has been archived by the owner on Feb 13, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0d2e9dd
commit 698254a
Showing
1 changed file
with
29 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
# console | ||
A set of useful commands to keep your Laravel applications fresh | ||
# Shift - Console | ||
A set of useful `artisan` commands to keep your Laravel applications fresh. | ||
|
||
## Installation | ||
You can install the Shift Console via composer using the following command: | ||
|
||
```sh | ||
composer require --dev laravel-shift/blueprint | ||
``` | ||
|
||
Shift Console will automatically register itself using [package discovery](https://laravel.com/docs/packages#package-discovery). | ||
|
||
## Requirements | ||
Shift Console requires a Laravel application running version 6.0 or higher. **Not running the latest version?** [Run Shift](https://laravelshift.com/shifts). | ||
|
||
## Basic Usage | ||
Currently, the Shift Console includes set `artisan` commands under the `shift` namespace. Currently, there is only one command - `shift:check-routes`. | ||
|
||
```sh | ||
php artisan shift:build | ||
``` | ||
|
||
This command checks for _Dead Routes_ by reviewing your application routes for references to undefined controllers, methods, or invalid visibility. | ||
|
||
## Contributing | ||
Contributions may be made by submitting a Pull Request against the `master` branch. Any submissions should be complete with tests and adhere to the [PSR-2 code style](https://www.php-fig.org/psr/psr-2/). | ||
|
||
You may also contribute by [opening an issue](https://github.com/laravel-shift/console/issues) to report a bug or suggest a new feature. | ||
|