Skip to content
This repository has been archived by the owner on Feb 13, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonmccreary committed Jan 10, 2020
1 parent 0d2e9dd commit 698254a
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
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.

0 comments on commit 698254a

Please sign in to comment.