Skip to content

Commit 8270a07

Browse files
committed
Update README
1 parent 4aefc8e commit 8270a07

1 file changed

Lines changed: 37 additions & 19 deletions

File tree

README.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@
1616
- [Job Types](#types-of-ways-jobs-can-be-run)
1717
- [Creating Jobs Programmatically](#manually-creating-the-jobs-in-your-application)
1818
- [Creating Jobs via Browser](#creating-jobs-via-the-browser-interface)
19-
5. [Dependencies](#dependencies)
20-
6. [TODO](#todo)
21-
7. [Contributing](#contributing)
19+
5. [Testing](#testing)
20+
6. [Dependencies](#dependencies)
21+
7. [TODO](#todo)
22+
8. [Additional info / Contributing](#additional-info--contributing)
2223

23-
## Features:
24+
## Features
2425

2526
- Schedule any command from your app as a server-side job, either programmatically or through a browser interface.
2627
- Run jobs right away, postpone them or make them recurring.
@@ -29,13 +30,13 @@
2930
- Add related entity and parent job.
3031
- Capture and store specific output from commands in the job's output parameters.
3132

32-
## Installation:
33+
## Installation
3334

3435
```
3536
composer require tomatom/jobqueuebundle
3637
```
3738

38-
## Configuration:
39+
## Configuration
3940

4041
#### config/bundles.php:
4142

@@ -164,7 +165,7 @@ For recurring messages you also need the scheduler running so the jobs are creat
164165
php bin/console messenger:consume scheduler_job_recurring
165166
```
166167

167-
## Usage:
168+
## Usage
168169

169170
#### Types of ways jobs can be run
170171

@@ -352,29 +353,46 @@ translations/messages.{locale}.yaml:
352353

353354
(Currently there are only translations for *en* and *cs* locales)
354355

355-
## Dependencies:
356+
## Testing
357+
358+
The bundle has ready tests for job creations in the tests/ folder.
359+
Running tests in your app can be done like this:
360+
361+
```bash
362+
vendor/bin/phpunit vendor/tomatom/jobqueuebundle/tests/
363+
```
364+
365+
The tests are also run on every push / pull request on GitHub.
366+
367+
## Dependencies
356368

357369
* "php": ">=8.1",
358370
* "doctrine/doctrine-bundle": "^2",
359371
* "doctrine/orm": "^2|^3",
360372
* "dragonmantank/cron-expression": "^3",
361373
* "knplabs/knp-paginator-bundle": "^6",
362374
* "spiriitlabs/form-filter-bundle": "^11",
363-
* "symfony/form": "^6.4",
364-
* "symfony/framework-bundle": "^6.4",
365-
* "symfony/lock": "^6.4",
366-
* "symfony/messenger": "^6.4",
367-
* "symfony/process": "^6.4",
368-
* "symfony/scheduler": "^6.4",
369-
* "symfony/security-bundle": "^6.4",
370-
* "symfony/translation": "^6.4",
375+
* "symfony/form": "6.4 || ^7.2",
376+
* "symfony/framework-bundle": "6.4 || ^7.2",
377+
* "symfony/lock": "6.4 || ^7.2",
378+
* "symfony/messenger": "6.4 || ^7.2",
379+
* "symfony/process": "6.4 || ^7.2",
380+
* "symfony/scheduler": "6.4 || ^7.2",
381+
* "symfony/security-bundle": "6.4 || ^7.2",
382+
* "symfony/translation": "6.4 || ^7.2",
371383
* "twig/twig": "^2|^3"
372384

373-
## TODO:
385+
## TODO
374386

375-
Add tests<br>
376387
[Handle getting changes of recurring jobs in better way](/../../issues/3)
377388

378-
## Contributing:
389+
## Additional info / Contributing
390+
391+
Special thanks to [schmittjoh](https://github.com/schmittjoh) for the
392+
original [JMSJobQueueBundle](https://github.com/schmittjoh/JMSJobQueueBundle).
393+
394+
This bundle **is not a fork, nor is building on top of the original bundle**, it's our own take on the console
395+
command scheduling, so please bear that in mind when using it. However, going from the original to this bundle should be
396+
seamless.
379397

380398
Feel free to open any issues or pull requests if you find something wrong or missing what you'd like the bundle to have!

0 commit comments

Comments
 (0)