Skip to content

Commit b6deb39

Browse files
update docs and branding
1 parent 4385389 commit b6deb39

File tree

2 files changed

+13
-37
lines changed

2 files changed

+13
-37
lines changed

README.md

Lines changed: 13 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
# Provides an Artisan command to cancel a queued batch of jobs
22

3+
![package image](resources/package-image.png)
4+
35
[![Latest Version on Packagist](https://img.shields.io/packagist/v/macbookandrew/laravel-queue-cancel-batch.svg?style=flat-square)](https://packagist.org/packages/macbookandrew/laravel-queue-cancel-batch)
46
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/macbookandrew/laravel-queue-cancel-batch/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/macbookandrew/laravel-queue-cancel-batch/actions?query=workflow%3Arun-tests+branch%3Amain)
57
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/macbookandrew/laravel-queue-cancel-batch/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/macbookandrew/laravel-queue-cancel-batch/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
68
[![Total Downloads](https://img.shields.io/packagist/dt/macbookandrew/laravel-queue-cancel-batch.svg?style=flat-square)](https://packagist.org/packages/macbookandrew/laravel-queue-cancel-batch)
79

8-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
9-
10-
## Support us
11-
12-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/laravel-queue-cancel-batch.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/laravel-queue-cancel-batch)
13-
14-
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
15-
16-
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
10+
This package provides a command to cancel a specific batch of queued jobs.
1711

1812
## Installation
1913

@@ -23,37 +17,19 @@ You can install the package via composer:
2317
composer require macbookandrew/laravel-queue-cancel-batch
2418
```
2519

26-
You can publish and run the migrations with:
27-
28-
```bash
29-
php artisan vendor:publish --tag="laravel-queue-cancel-batch-migrations"
30-
php artisan migrate
31-
```
32-
33-
You can publish the config file with:
34-
35-
```bash
36-
php artisan vendor:publish --tag="laravel-queue-cancel-batch-config"
37-
```
38-
39-
This is the contents of the published config file:
40-
41-
```php
42-
return [
43-
];
44-
```
45-
46-
Optionally, you can publish the views using
20+
## Usage
4721

48-
```bash
49-
php artisan vendor:publish --tag="laravel-queue-cancel-batch-views"
50-
```
22+
```shell
23+
# search for active batches and chancel one or more
24+
php artisan queue:cancel-batch
5125

52-
## Usage
26+
┌ Select one or more batches to cancel ─────────────────────────┐
27+
│ My Test Batch (44/56 completed jobs; started 3 seconds ago) │
28+
│ My Test Batch 2 (12/56 completed jobs; started 1 second ago) │
29+
└───────────────────────────────────────────────────────────────┘
5330

54-
```php
55-
$laravelQueueCancelBatch = new MacbookAndrew\LaravelQueueCancelBatch();
56-
echo $laravelQueueCancelBatch->echoPhrase('Hello, MacbookAndrew!');
31+
# cancel a batch if you already have the batch ID
32+
php artisan queue:cancel-batch 70045ad7-3279-4481-9b1e-012710f22221
5733
```
5834

5935
## Testing

resources/package-image.png

75.9 KB
Loading

0 commit comments

Comments
 (0)