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

Commit 698254a

Browse files
committed
Update README
1 parent 0d2e9dd commit 698254a

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
1-
# console
2-
A set of useful commands to keep your Laravel applications fresh
1+
# Shift - Console
2+
A set of useful `artisan` commands to keep your Laravel applications fresh.
3+
4+
## Installation
5+
You can install the Shift Console via composer using the following command:
6+
7+
```sh
8+
composer require --dev laravel-shift/blueprint
9+
```
10+
11+
Shift Console will automatically register itself using [package discovery](https://laravel.com/docs/packages#package-discovery).
12+
13+
## Requirements
14+
Shift Console requires a Laravel application running version 6.0 or higher. **Not running the latest version?** [Run Shift](https://laravelshift.com/shifts).
15+
16+
## Basic Usage
17+
Currently, the Shift Console includes set `artisan` commands under the `shift` namespace. Currently, there is only one command - `shift:check-routes`.
18+
19+
```sh
20+
php artisan shift:build
21+
```
22+
23+
This command checks for _Dead Routes_ by reviewing your application routes for references to undefined controllers, methods, or invalid visibility.
24+
25+
## Contributing
26+
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/).
27+
28+
You may also contribute by [opening an issue](https://github.com/laravel-shift/console/issues) to report a bug or suggest a new feature.
29+

0 commit comments

Comments
 (0)