-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from binafy/readme
[0.x] README
- Loading branch information
Showing
2 changed files
with
61 additions
and
0 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 +1,62 @@ | ||
# Artisan Finder | ||
|
||
<img src="https://banners.beyondco.de/Artisan%20Finder.png?theme=light&packageManager=composer+require&packageName=binafy%2Fartisan-finder&pattern=signal&style=style_2&description=Find+your+artisan+command&md=1&showWatermark=0&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg" alt="artisan finder"> | ||
|
||
[![PHP Version Require](https://img.shields.io/packagist/dependency-v/binafy/artisan-finder/php)](https://packagist.org/packages/binafy/artisan-finder) | ||
[![Latest Stable Version](https://img.shields.io/packagist/v/binafy/artisan-finder.svg?style=flat-square)](https://packagist.org/packages/binafy/artisan-finder) | ||
[![Total Downloads](https://img.shields.io/packagist/dt/binafy/artisan-finder.svg?style=flat-square)](https://packagist.org/packages/binafy/artisan-finder) | ||
[![License](https://img.shields.io/packagist/l/binafy/artisan-finder)](https://packagist.org/packages/binafy/artisan-finder) | ||
[![Passed Tests](https://github.com/binafy/artisan-finder/actions/workflows/tests.yml/badge.svg)](https://github.com/binafy/artisan-finder/actions/workflows/tests.yml) | ||
|
||
<a name="introduction"></a> | ||
## Introduction | ||
|
||
Artisan Finder is a Laravel package that introduces a convenient command called `find:art`. This command provides an interactive select input, allowing you to quickly search through available artisan commands and execute them immediately. It's designed to enhance your workflow by making it easier to locate and run artisan commands without the need to remember exact command names, offering a faster and more efficient development experience. | ||
|
||
<a name="installation"></a> | ||
## Installation | ||
|
||
You can install the package with Composer: | ||
|
||
```bash | ||
composer require binafy/artisan-finder --dev | ||
``` | ||
|
||
> **_NOTE:_** We suggest to install the package in development mode. | ||
<a name="how-to-work"></a> | ||
## How to Work | ||
|
||
For working with `Artisan Finder`, you can just run below command on your terminal: | ||
|
||
```shell | ||
php artisan find:art | ||
``` | ||
|
||
When you run this command, this command show you a search box, and you can search your command and run it immediately: | ||
|
||
![Artisan Finder Gif](art/video.gif) | ||
|
||
> **_NOTE:_** Thank you [Hamid-Reza Khosravi](https://github.com/hrk-ir) for creating this video. | ||
<a name="contributors"></a> | ||
## Contributors | ||
|
||
Thanks to all the people who contributed. [Contributors](https://github.com/binafy/artisan-finder/graphs/contributors). | ||
|
||
<a href="https://github.com/binafy/artisan-finder/graphs/contributors"><img src="https://opencollective.com/artisan-finder/contributors.svg?width=890&button=false" /></a> | ||
|
||
<a name="security"></a> | ||
## Security | ||
|
||
If you discover any security-related issues, please email `binafy23@gmail.com` instead of using the issue tracker. | ||
|
||
<a name="chanelog"></a> | ||
## Changelog | ||
|
||
The changelog can be found in the `CHANGELOG.md` file of the GitHub repository. It lists the changes, bug fixes, and improvements made to each version of the `Artisan Finder` package. | ||
|
||
<a name="license"></a> | ||
## License | ||
|
||
The MIT License (MIT). Please see [License File](https://github.com/binafy/artisan-finder/blob/1.x/LICENSE) for more information. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.