Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RahulDey12 authored Sep 9, 2021
1 parent 4050a9d commit 700362e
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Laravel Console Spinner
Laravel Console Spinner was created by [Rahul Dey](https://github.com/RahulDey12). It is just a custom Progress Bar inspired by [icanhazstring/symfony-console-spinner](https://github.com/icanhazstring/symfony-console-spinner).

[![Total Downloads](http://poser.pugx.org/rahul900day/laravel-console-spinner/downloads)](https://packagist.org/packages/rahul900day/laravel-console-spinner)
[![Version](http://poser.pugx.org/rahul900day/laravel-console-spinner/version)](https://packagist.org/packages/rahul900day/laravel-console-spinner)
[![PHP Version Require](http://poser.pugx.org/rahul900day/laravel-console-spinner/require/php)](https://packagist.org/packages/rahul900day/laravel-console-spinner)

## Installation
> **Requires [PHP 7.3+](https://php.net/releases/)**
Expand All @@ -10,6 +14,19 @@ Via [Composer](https://getcomposer.org):
composer require rahul900day/laravel-console-spinner
```

You can publish the config file with:
```bash
php artisan vendor:publish --tag=console-spinner-config
```

This is the contents of the published config file:

```php
return [
'chars' => ['⠏', '⠛', '⠹', '⢸', '⣰', '⣤', '⣆', '⡇'],
];
```

## Usage
```php
class SimpleLaravelCommand extends Command
Expand Down Expand Up @@ -44,4 +61,4 @@ $this->withSpinner(User::all(), function($user) {
```

## Licence
This package is released under the [MIT license](https://github.com/RahulDey12/laravel-console-spinner/blob/master/LICENSE).
This package is released under the [MIT license](https://github.com/RahulDey12/laravel-console-spinner/blob/master/LICENSE).

0 comments on commit 700362e

Please sign in to comment.