From 698254a18d7177d175fc5a92c173f3b0ff6e8551 Mon Sep 17 00:00:00 2001 From: Jason McCreary Date: Fri, 10 Jan 2020 18:45:51 -0500 Subject: [PATCH] Update README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 00faed2..91111d6 100644 --- a/README.md +++ b/README.md @@ -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. +